Abruf per API von Dokumentsteckbrief über ID
Beschreibung der Story
Die Dokumentensteckbriefe sollen nach einem Teil der ID durchsuchbar sein. Ausserdem soll fuer eine bekannte ID und Version ein einzelner Dokuementensteckbrief abrufbar sein.
Relevante Links und Bemerkungen
- Die API und die Datenbank werden nicht zu Projektbeginn einmalig konzipiert und festgelegt, sondern wachsen über die Produktinkremente sprintweise.
- Die Suchergebnisse umfassen nur die Metadaten, nicht die eigentlichen Dokumentsteckbriefe. Das Suchergebnis mit Dokumentsteckbrief ist Gegenstand einer anderen User Story
Akzeptanzkriterien
-
GET /api/v0/steckbrief?term="D00"
liefert eine Liste von einem oder mehreren Dokumentsteckbriefen, bei denen der Suchparameter identisch mit dem oder ein Teil des Inhalt von "ID des Dokumentsteckbrief inkl. Version" ist. Beispielparameter: "D00000075" oder "D00" oder "75". Gibt es keinen solchen Dokumentsteckbrief, dann ist die Liste leer und der Ergebniscode entsprechend. -
GET /api/v0/steckbrief/id
liefert alle Versionen des Dokumentensteckbriefs mit der angegebenen ID. -
GET /api/v0/profiles/id/version
liefert eine einen Dokumentsteckbrief, bei dem der Suchparameter identisch mit dem oder ein Teil des Inhalt von "ID des Datenschemas inkl. Version" ist. Beispielparameter: "D00000075V1.0". Gibt es keinen solchen Dokumentsteckbrief, dann ist der Ergebniscode entsprechend. -
OpenAPI Dokumentation
Edited by Felix Bernhardt