API-Leitfaden

Celoxis API v2

Über die REST-API können Sie Celoxis-Daten abrufen, erstellen, aktualisieren und löschen sowie unterstützte Entitätsaktionen durchführen.

Basis-URL

Alle Endpunkte beziehen sich auf Ihre Celoxis-Installation:

Text

Beispiel

https://<your-celoxis-host> /psa/api/v2

Die Beispiele verwenden https://app.celoxis.com/psa/api/v2.

Unterstützte Entitäten

Eine Entität ist ein bestimmter Datensatztyp in Celoxis, beispielsweise ein Projekt. Entitäten stehen außerdem in Beziehung zu anderen Entitäten. So ist beispielsweise eine Aufgabe mit ihrem Projekt und mit einer anderen Aufgabe, die ihr übergeordnetes Projekt ist, verknüpft.

Verwenden Sie den Entitätsschlüssel in API-URLs. Ersetzen Sie in den folgenden Pfaden {entity} durch einen Schlüssel aus dieser Tabelle.

Name	Entitätsschlüssel	Verbände
Projekte	`Projekte`	Manager, Kunden
Aufgaben	`Aufgaben`	Projekt, übergeordnetes Projekt, Vorgängerprojekte, Aufgaben
Aufgabenaktualisierungen	`Aufgabenaktualisierungen`	—
App-Updates	`App-Updates`	—
Zeiteinträge	`Zeiteinträge`	Benutzer, Arbeitselement
Workflow-App-Datensätze	`Apps`	—
Benutzer	`Nutzer`	—
Kosten	`Kosten`	—

Eigenschaften

Dieser Leitfaden dokumentiert den stabilen API-Vertrag: URLs, Methoden, Anfrageverhalten, Antworten und Beispiele.