Vai al contenuto principale
La Vantage API consente di accedere ai Parameter delle Document skill e delle Process skill e di modificarne i valori per una determinata transaction. I Parameter delle Skill passati in una transaction sono costituiti da coppie chiave-valore di tipo string. Per i Parameter delle Document skill e delle Process skill, i valori impostati tramite la Vantage API hanno priorità su quelli impostati tramite la Vantage UI.

​
Modifica dei valori dei Parameter della Skill

Per modificare i valori dei Parameter della skill tramite la Vantage API, procedi come segue:

​
Passo 1: creare o inizializzare una Transaction

Crea una transaction vuota oppure inizializza una transaction usando il metodo launch. Per farlo, invia una richiesta POST alla risorsa transactions: 
POST {your-host}/api/publicapi/v1/transactions
o 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
Nel corpo della richiesta, specifica i nuovi valori per i Parameter dello Skill ed esegui il comando seguente:

​
Esempio per Windows

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

​
Esempio per 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"}]}'
Nota: È possibile avere al massimo 10 parametri skill key-value, con ogni chiave fino a 128 caratteri e ogni valore fino a 256 caratteri.

​
Ottenere i valori dei Parameter dello Skill

Per ottenere i valori dei Parameter dello Skill utilizzando la Vantage API, eseguire una delle seguenti operazioni:

​
Opzione 1: ottenere direttamente i Parameter della Skill

Invia una richiesta GET alla risorsa transactions/{transaction-id}/skillParameters: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
La risposta sarà simile a: 
[
  {
    "key": "Nuovo Parameter",
    "value": "Vendors"
  }
]

​
Opzione 2: Scaricare i file della Transaction

Invia una richiesta GET alla risorsa transactions/{transaction-id}/files/{file-id}/download per ottenere i valori in formato JSON: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download