...
Als Authentizierungsverfahren wird HTTP Basic Authentication verwendet.
Die API unterstützt außerdem für fast alle Anfragen den Query-Parameter runas. Mit diesem können Adminstratoren diese Methoden im Namen anderer Benutzer ausführen.
Parameter
Viele API-Methoden akzeptieren Parameter. Bei GET-Anfragen werden diese als Query-Parameter übermittelt. Bei POST- und PATCH-Anfragen werden die Änderungen im Body der Anfrage mit dem Content-Type application/json oder – optional – bei PATCH-Anfragen mit dem Content-Type application/merge-patch+json übermittelt.
Der Parameter runas wird unabhängig von der Anfrage immer als Query-Parameter übermittelt.
HTTP-Verben
Die URN-Service API strebt eine korrekte Nutzung der HTTP-Verben an.
| HTTP-Verb | Beschreibung |
|---|---|
HEAD | Wird benutzt, um nur die HTTP-Header für eine Ressource abzufragen |
GET | Wird für das Abfragen von Ressourcen genutzt |
POST | Wird benutzt, um neue Ressourcen anzulegen |
PATCH | Wird verwendet, um Ressourcen mit partiellen JSON-Objekten zu aktualisieren |
PUT | Wird aktuell nicht von der REST-API verwendet |
DELETE | Wird benutzt, um Ressourcen zu löschen |
Fehler
Hypermedia
Paging
Referenz
Eine detaillierte Übersicht über alle Befehle der REST-API wird als Teil der REST-API unter docs/index.html angeboten.
...