API Benutzerdokumentation

Kurzanleitung

Die Umantis ATS API bietet eine Sammlung von API Endpunkten, die die Integration zwischen dem Umantis ATS und anderen Anwendungen innerhalb der Infrastruktur unserer Kunden unterstützt.

Allgemeine Informationen

Die technische Dokumentation der API kann über den Endpunkt /openapi abgerufen werden.

Die API bietet die Möglichkeit, verschiedene Ressourcentypen abzurufen, zu erstellen oder zu ändern. Die folgenden Punkte sind für alle Anfragen obligatorisch:

• Clients MÜSSEN den Accept http-Header bereitstellen, in der Regel mit application/vnd.api+json als Medientypbezeichnung.
  Im Falle des Medientyps application/vnd.api+json sind keine Medientypparameter zulässig.
• Clients MÜSSEN den Authorization http-Header bereitstellen, wie im Abschnitt „Authentifizierung“ beschrieben.

Die Antwort wird in JSON zurückgegeben, und zwar gemäss der JSON:API-Dokumentstruktur. In den meisten Fällen ist es möglich, die auszugebenden Datensätze zu filtern. Felder, nach denen gefiltert werden kann, sind durch den Tag #filterable gekennzeichnet. Zusätzlich ist es auch möglich, über den Query-Parameter "fields[RELATIONSHIP]" die auszugebenden Felder innerhalb eines Datensatzes zu filtern. Weitere Informationen sind in der technischen Dokumentation unter <LINK zur SWAGGER Dokumentation> zu finden.