Änderungen an Request/Response für Dokumentsteckbrief suche

Warum machen wir das?

Bei der Suche nach einem Dokumentsteckbrief über den Endpunkt GET /api/v0/document-profile gibt es zahlreiche Request-Parameter und viele Response-Daten. Um einem anbindenden System (Redaktionssystem, Auswertungen o.a.) mehr Möglichkeiten anzubieten, sollen diese Request-/Response-Daten erweitert werden.

Relevante Informationen

Die Quelle für diese Anforderung ist eine Excel-Tabelle von Volker Schmitz, die in der Nextcloud abgelegt wurde: Link

Akzeptanzkriterien

Folgende Request-Parameter werden im Zusammenhang mit der Suche nach Datenschemata angefordert (bzw. sind bereits umgesetzt)

• ID
• Versionsnummer
• letzte Version
• Status
• Detaillierungsstufe (über Stichwort-Suche)
• istAbstrakt
• Herausgeber - nicht Autor (noch zu klären)
• Anwendungsgebiet (über Stichwort-Suche)
• Änderungsdatum ab (analog `status _gesetzt_seit bei Schema-Filterung)
• Änderungsdatum bis (analog `status _gesetzt_bis bei Schema-Filterung)
• Bezeichnung
• Dokumentart
• Tag: Kategorie (über Stichwort-Suche)
• Tag: Wert (über Stichwort-Suche)
• xdf_version
• name (schon umgesetzt)
• freigabe_status (schon umgesetzt)
• status_gesetzt_durch (schon umgesetzt)
• Nummernkreis (schon umgesetzt)
• Handlungsgrundlage (bezug - schon umgesetzt)
• fts_query (schon umgesetzt)
• Versionshinweis (schon umgesetzt)
• Datum des letzten Uploads (updated_since - schon umgesetzt)
• Paginierung Startseite (schon umgesetzt)
• Paginierung Seitengröße (schon umgesetzt)

Folgende Response-Daten werden im Zusammenhang mit der Suche nach Datenschemata angefordert (bzw. sind bereits umgesetzt)

• ID (schon umgesetzt)
• Version (schon umgesetzt)
• Nummernkreis (schon umgesetzt)
• Name (schon umgesetzt)
• Definition (schon umgesetzt)
• Status (als Zahlenwert - schon umgesetzt)
• Status (als Text - schon umgesetzt)
• Status gesetzt durch (schon umgesetzt)
• Handlungsgrundlage (schon umgesetzt mit bezug)
• Versionshinweis (umgesetzt)
• Änderungsdatum (umgesetzt mit letzte_aenderung)
• Datum des letzten Uploads (last_update - schon umgesetzt)
• offset (schon umgesetzt)
• limit (schon umgesetzt)
• count (schon umgesetzt)
• Herausgeber - nicht Autor (noch zu klären)
• Definition
• Bezeichnung (für XDF3 aus der Dokumentsteckbrief-Teil-Datenstruktur) bzw. BezeichnungEingabe (für XDF2 aus der AllgemeineAngaben-Teil-Datenstruktur)
• gueltigAb (vgl. #48 (closed) und #49 (closed))
• gueltigBis (vgl. #48 (closed) und #49 (closed))
• statusGesetztAm
• Dokumentart
• Abstrakt
• xdf_version
• Stichwort mit Kategorie/Wert