Saltar al contenido principal
La Vantage API permite acceder a los parámetros de Skill de documento y de Habilidad de proceso y cambiar sus valores para una transacción específica. Los parámetros de Skill enviados en una transacción consisten en pares clave‑valor de cadena. Para los parámetros de Skill de documento y de Habilidad de proceso, los valores establecidos a través de la Vantage API tendrán prioridad sobre los establecidos a través de la Vantage UI.

Cambiar los valores de Parameter de una Skill

Para cambiar los valores de Parameter de una skill mediante la Vantage API, haga lo siguiente:

Paso 1: Crear o inicializar una transacción

Cree una transacción vacía o inicialice una transacción con el método launch. Para ello, envíe una solicitud POST al recurso transactions:
POST {your-host}/api/publicapi/v1/transactions
o
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
En el cuerpo de la solicitud, especifique nuevos valores para los parámetros de la skill y ejecute el siguiente comando:

Ejemplo de Windows

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

Ejemplo de 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: Puede haber un máximo de 10 parámetros de skill de tipo clave-valor, y cada clave puede contener hasta 128 caracteres y cada valor hasta 256 caracteres.

Obtener valores de Parameter de Habilidad

Para obtener los valores de parámetros de skill mediante la Vantage API, haga una de las siguientes acciones:

Opción 1: Obtener los Parameters de la Skill directamente

Envíe una solicitud GET al recurso transactions/{transaction-id}/skillParameters:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
La respuesta tendrá el siguiente formato:
[
  {
    "key": "Nuevo Parameter",
    "value": "Vendors"
  }
]

Opción 2: Descargar archivos de la Transacción

Envía una solicitud GET al recurso transactions/{transaction-id}/files/{file-id}/download para obtener los valores en formato JSON:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download