Änderungen an Request/Response für Schemasuche

Warum machen wir das?

Bei der Suche nach einem Schema über den Endpunkt GET /api/v0/schema 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 Liste beschreibt sämtliche Parameter und den bisherigen Umsetzungsstatus oder ob es zurückgestellt ist oder ob es unklar ist:

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

• ID (umgesetzt)
• Versionsnummer (umgesetzt)
• letzte Version: (#314 (closed))
• Gültigkeit ab (umgesetzt)
• Gültigkeit bis (umgesetzt)
• Status (umgesetzt)
• Detaillierungsstufe (umgesetzt über Stichwort-Suche)
• Herausgeber - nicht Autor (unklar)
• Anwendungsgebiet (umgesetzt über Stichwort-Suche)
• Änderungsdatum ab (umgesetzt wurde bisher Filterung nach letzte_aenderung)
• Änderungsdatum bis (umgesetzt wurde bisher Filterung nach letzte_aenderung)
• Handlungsgrundlage.Inhalt (umgesetzt)
• Handlungsgrundlage.Inhalt auch in allen Unterelementen (zurückgestellt)
• Status gesetzt durch (umgesetzt)
• ID der Unterelemente (unklar)
• Status gesetzt am - ab (zurückgestellt)
• Status gesetzt am - bis (zurückgestellt)
• Tag: Kategorie (umgesetzt über Stichwort-Suche)
• Tag: Wert (umgesetzt über Stichwort-Suche)
• Paginierung Startseite (umgesetzt)
• Paginierung Seitengröße (umgesetzt)

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

• Suchparameter die für die Ausgangs-Suche (zurückgestellt)
• Paginierung (zurückgestellt)
• ID (umgesetzt)
• Version (umgesetzt)
• Versionshinweis (umgesetzt)
• Name (umgesetzt)
• Definition (umgesetzt)
• Bezeichnung/BezeichungEingabe (offen)
• Handlungsgrundlage (umgesetzt mit bezug)
• Gültigkeit ab (umgesetzt)
• Gültigkeit bis (umgesetzt)
• Änderungsdatum (umgesetzt mit letzte_aenderung)
• Status (umgesetzt)
• Status gesetzt am (offen)
• Status gesetzt durch (umgesetzt)
• Detaillierungsstufe (umgesetzt mit Stichwort)
• Herausgeber - nicht Autor (unklar)
• Anwendungsgebiet (umgesetzt mit Stichwort)
• Dokumentsteckbrief (umgesetzt)
• Codelisten (umgesetzt, erfordert einen zweiten API-Aufruf)
• Tag/Kategorie (umgesetzt mit Stichwort)
• Tag/Wert (umgesetzt mit Stichwort)