Endpunkt

In diesem Dokument wird der Endpunkt zur Ausführung einer vordefinierten WebCLI Aktion beschrieben.

Der Endpunkt erfordert eine Authentifizierung mittels API Key.

WebCLI Aktion ausführen

CODE

POST /actions/{actionId}
Content-Type: application/json
x-api-key: ...

{}

Führt eine vordefinierte Aktion mit der angegebenen actionId ohne Angabe weiterer Parameter aus.

WebCLI Aktion mit zusätzlichen Parametern ausführen

Führt eine vordefinierte Aktion mit der angegebenen actionId und zusätzlichen Parametern aus. Der Endpunkt erwartet ein Objekt mit der Eigenschaft Arguments im Request-Body:

JSON

POST /actions/{actionId}
Content-Type: application/json
x-api-key: ...

{ "Arguments": "additional data" }

Der {%Parameters%} Platzhalter innerhalb einer WebCLI Aktion wird durch den im Request-Body angegebenen Arguments-String in Base64-kodierter Form ersetzt (siehe Verwendung von Parametern).

Vergessen Sie nicht die Angabe des Headers Content-Type: application/json.