Accès aux Paramètres de Skill via l’API Vantage

L’API Vantage vous permet d’accéder aux Paramètres de Skill de document et de processus et d’en modifier les valeurs pour une transaction spécifique. Les paramètres se composent de paires clé‑valeur de type string. Les valeurs définies via l’API priment sur celles définies dans l’interface Vantage.”

Modifier les valeurs des Paramètres de Skill

Pour modifier les valeurs des Paramètres de Skill d’une transaction, créez une nouvelle transaction (ou lancez-en une) via POST et incluez les nouvelles valeurs dans le corps de la requête skillParameters. Créer une transaction vide :

POST {your-host}/api/publicapi/v1/transactions

Ou démarrez une transaction qui exécute une compétence spécifique :

POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}

Incluez de nouvelles valeurs de paramètres dans le corps de la requête :

Windows
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\"}]}"

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"}]}'

Une transaction peut comporter jusqu’à 10 Paramètres de Skill sous forme de paires clé-valeur. Les clés sont limitées à 128 caractères ; les valeurs, à 256.

Récupération des valeurs de paramètre de compétence

Utilisez l’une des méthodes suivantes pour récupérer les valeurs de paramètre de compétence.

Interroger le point de terminaison `skillParameters`

Envoyez une requête GET :

GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/

Réponse :

[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

Télécharger le fichier de la transaction

Envoyez une requête GET pour télécharger le fichier de la transaction, qui contient les valeurs des paramètres au format JSON :

GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download

​Modifier les valeurs des Paramètres de Skill

​Récupération des valeurs de paramètre de compétence

​Interroger le point de terminaison skillParameters

​Télécharger le fichier de la transaction

​Rubriques connexes

Modifier les valeurs des Paramètres de Skill

Récupération des valeurs de paramètre de compétence

Interroger le point de terminaison `skillParameters`

Télécharger le fichier de la transaction

Rubriques connexes