Dieser WebService ist über die URL ROOTVP/ws/rest abrufbar.
Alle Zugriffspunkte auf diesen WebService müssen das Attribut apikey mit dem Wert definieren, der vom Admin Center für den jeweiligen Anwender bereitgestellt wird.
Um beispielsweise die Liste der Bezeichnungen der verfügbaren Attribute abzurufen, lautet die URL daher wie folgt:
ROOTVP/ws/rest/attributes ?apikey= xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Dabei steht „xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx“ für den bereitgestellten Schlüssel.
Für alle anderen Zugriffspunkte wird das Attribut apikey als Parameter im Header der Abfrage verwendet und daher nicht in der URL-Zeile angegeben.
Beispiel in Java-Code:
HttpURLConnection connection = (HttpURLConnection) new URL( url ).openConnection();
Verbindung. setRequestProperty (apikey, „xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx“);
Der gesamte Datenaustausch sowie alle Rückgabewerte der API sind in UTF-8 kodiert.
Liste der Zugriffspunkte
| Vorgehensweise | EndPoint | Verwendung | Rückgabewert |
|---|---|---|---|
| GET | /ws/rest/attributes | Ruft die Bezeichnungen der verfügbaren Attribute ab. | Zeichenkette |
| GET | /ws/rest/event/export | Stellt die Eigenschaften eines Vorgangs anhand eines Vorgangsexportkontexts bereit. | EntityInfoResult |
| POST | /ws/rest/event/get | Beschreibt die Eigenschaften einer Reihe von Vorgängen. | EntityInfoResult |
| POST | /ws/rest/event/add | Erstellt einen neuen Vorgang. | WSResult |
| PUT | /ws/rest/vorgang/modify | Bearbeitet die Eigenschaften eines Vorgangs. | WSResult |
| DELETE | /ws/rest/event/delete | Löscht einen Vorgang. | WSResult |
| GET | /ws/rest/resource/export | Stellt die Eigenschaften einer Ressource anhand eines Ressourcenexportkontexts bereit. | EntityInfoResult |
| POST | /ws/rest/resource/get | Beschreibt die Eigenschaften einer Reihe von Ressourcen. | EntityInfoResult |
| POST | /ws/rest/resource/add | Erstellt eine neue Ressource. | WSResult |
PUT /ws/rest/resource/modify – Bearbeitet die Eigenschaften einer Ressource. WSResult
DELETE /ws/rest/resource/delete – Löscht eine Ressource. WSResult
| POST | /ws/rest/link/create | Stellt eine Verknüpfung zwischen zwei Vorgängen her. | WSResult |
|---|---|---|---|
| DELETE | /ws/rest/link/delete | Löscht eine Verknüpfung zwischen zwei Vorgängen. | WSResult |