Einleitung
In diesem Thema findest du allgemeine Informationen zur Scripting-API.
Funktionsumfang der Scripting-App
Mit der Scripting-App kannst du Skripte erstellen, bearbeiten und ausführen.
Siehe auch:
- Starten eines Skriptes
- Abfragen aller Protokolle eines Skriptes
- Abfragen des Inhalts eines bestimmten Protokolls
Starten eines Skriptes
Mit dieser HTTP-Schnittstelle kannst du Skripte ausführen.
- URI: /scripting/script/{scriptId}/run
- Methoden: POST, GET, PUT, DELETE, PATCH
Request
Du kannst die Schnittstelle optional mit einem beliebigen Body aufrufen, um diesen im Skript auszuwerten. Dabei werden alle Content-Types unterstützt. (application/json, text/plain etc.)
POST, GET, PUT, DELETE, PATCH /scripting/script/{scriptId}/run
{
"name": "John Smith"
}
Response
Inhalt und Inhaltstyp sind abhängig von der Antwort des Skriptes.
Rückgabewerte
- Beliebig: Der Status wird vom ausgeführten Skript individuell festgelegt.
- 401: Der Benutzer ist nicht authentifiziert.
- 404: Das Skript existiert nicht.
- 500: Das Skript konnte nicht gestartet werden.
- 502: Das Skript konnte nicht vollständig ausgeführt werden.
- 504: Das Skript wurde wegen einer zu langen Ausführungszeit gestoppt.
Abfragen aller Protokolle eines Skriptes
Du kannst eine Liste mit allen Protokollen der neusten Skriptversion abfragen.
- URI: /scripting/log/script/{scriptId}
- Methode: GET
Response
[
{
"executionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"scriptId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"executionDate": "2022-11-11T07:09:35Z",
"logType": 3
},
{
"executionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"scriptId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"executionDate": "2022-11-11T07:09:54Z",
"logType": 3
}
]
Rückgabewerte
- 200: Der Request war erfolgreich.
- 401: Der Benutzer ist nicht authentifiziert.
- 403: Der Benutzer ist nicht berechtigt, die Protokolle für dieses Skript abzufragen.
- 404: Das Skript existiert nicht.
- 500: Serverfehler.
Abfragen des Inhalts eines bestimmten Protokolls
Mit dieser HTTP-Schnittstelle kannst du den Inhalt der Protokolle von Skriptausführungen abfragen.
- URI: /scripting/log/script/{scriptId}/execution/{executionId}
- Methode: GET
Response
Inhalt und Inhaltstyp sind abhängig von der Antwort des Skriptes.
GET /scripting/log/script/{scriptId}/execution/{executionId}
Hello John Smith!
Rückgabewerte
- 200: Der Request war erfolgreich.
- 401: Der Benutzer ist nicht authentifiziert.
- 403: Der Benutzer ist nicht berechtigt, die Protokolle für dieses Skript abzufragen.
- 404: Das Skript existiert nicht.
- 500: Serverfehler.