Zum Hauptinhalt springen
Die Vantage-API ermöglicht es Ihnen, auf Parameter von Document-Skills und Process-Skills zuzugreifen und deren Werte für einen bestimmten Vorgang zu ändern. In einem Vorgang übergebene Skill-Parameter bestehen aus Schlüssel-Wert-Paaren vom Typ string. Für Parameter von Document- und Process-Skills haben über die Vantage-API gesetzte Werte Vorrang vor den in der Vantage-UI gesetzten Werten.

​
Skill-Parameterwerte ändern

So ändern Sie Skill-Parameterwerte über die Vantage-API:

​
Schritt 1: Eine Transaction erstellen oder initialisieren

Erstellen Sie eine leere Transaction oder initialisieren Sie eine Transaction mit der Methode launch. Senden Sie dazu eine POST-Anfrage an die Ressource transactions: 
POST {your-host}/api/publicapi/v1/transactions
oder 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
Geben Sie im Anforderungstext neue Werte für die Skill-Parameter an und führen Sie den folgenden Befehl aus:

​
Beispiel für Windows

curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"Neuer Parameter\",\"value\":\"Vendors neu\"}]}"

​
Beispiel für Linux

curl -X POST '{your-host}/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123","skillParameters":[{"key":"New parameter","value":"Vendors new"}]}'
Hinweis: Es können maximal 10 Key-Value-Skill-Parameter vorhanden sein, wobei jeder Schlüssel bis zu 128 Zeichen und jeder Wert bis zu 256 Zeichen enthalten darf.

​
Skill-Parameterwerte abrufen

Um Skill-Parameterwerte über die Vantage-API zu erhalten, führen Sie eine der folgenden Aktionen aus:

​
Option 1: Skill-Parameter direkt abrufen

Senden Sie eine GET-Anfrage an die Ressource transactions/{transaction-id}/skillParameters: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
Die Antwort sieht folgendermaßen aus: 
[
  {
    "key": "Neuer Parameter",
    "value": "Vendors"
  }
]

​
Option 2: Transaction-Dateien herunterladen

Senden Sie eine GET-Anfrage an die Ressource transactions/{transaction-id}/files/{file-id}/download, um die Werte im JSON-Format abzurufen: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download