Scripting-App

Scripting-App

 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

Mit dieser HTTP-Schnittstelle kannst du Skripte ausführen.

  • URI: /scripting/script/{scriptId}/run
  • Methoden: POST, GET, PUT, DELETE, PATCH

Hinweis

Die Skriptausführungen sind auf 10 simultane Ausführungen pro Mandant limitiert.

Request

Du kannst die Schnittstelle optional mit einem beliebigen Body aufrufen, um den Body im Skript auszuwerten. Beim Aufrufen 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.
  • 429: Das Limit von 10 simultanen Ausführungen wurde überschritten.
  • 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.

 Starten eines Skriptes im Hintergrund

Mit dieser HTTP-Schnittstelle kannst du Skripte im Hintergrund ausführen.

Hinweis

Die asynchronen Skriptausführungen sind auf insgesamt 100 simultane Ausführungen limitiert. Mit dieser Limitierung kann die synchrone Skriptausführung sichergestellt werden.

  • URI: /scripting/script/{scriptId}/background
  • Methoden: POST, GET, PUT, DELETE, PATCH

Request

Du kannst die Schnittstelle optional mit einem beliebigen Body aufrufen, um den Body im Skript auszuwerten. Beim Aufrufen werden alle Content-Types unterstützt. (application/json, text/plain etc.)


POST, GET, PUT, DELETE, PATCH /scripting/script/{scriptId}/background
{
    "name": "John Smith"
}

Response

Die Response informiert dich lediglich darüber, ob das Skript erfolgreich eingeplant werden konnte. Das Skript selbst antwortet nicht. Wenn du erfahren möchtest, ob das Skript erfolgreich gestartet werden konnte, kannst du die Konfiguration deines Skriptes entsprechend anpassen. Du kannst z.B. programmieren, dass das Skript den Status mittels URL an die entsprechende App sendet.

Die maximale Laufzeit von Hintergrundskripten ist auf 14 Minuten begrenzt. Die maximale Headergröße einer Anfrage beträgt 256kb.

Rückgabewerte

  • 202: Das Skript wurde erfolgreich eingeplant und wird in naher Zukunft gestartet.
  • 401: Der Benutzer ist nicht authentifiziert.
  • 404: Das Skript existiert nicht.
  • 500: Das Skript konnte nicht eingeplant werden.

 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.