跳转到主要内容
Vantage API 可用于访问文档技能和流程技能的参数,并为特定事务更改其值。在事务中传递的技能参数由键值 string 对组成。 对于文档技能和流程技能的参数,通过 Vantage API 设置的值将优先于通过 Vantage UI 设置的值。

更改技能的 Parameter 值

要通过 Vantage API 更改技能的 Parameter 值,请执行以下操作:

步骤 1:创建或初始化事务

创建一个空的事务,或使用 launch 方法初始化一个事务。为此,请向 transactions 资源发送 POST 请求:
POST {your-host}/api/publicapi/v1/transactions
或者
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
在请求正文中为技能参数指定新的值,然后运行以下命令:

Windows 示例

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

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"}]}'
注意: 最多可以有 10 个键值对形式的技能 Parameter,每个键的长度最多为 128 个字符,每个值的长度最多为 256 个字符。

获取技能的 Parameter 值

要使用 Vantage API 获取技能的 Parameter 值,请执行下列任一操作:

选项 1:直接获取 Skill Parameters

transactions/{transaction-id}/skillParameters 资源发送 GET 请求:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
响应如下所示:
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

选项 2:下载事务文件

transactions/{transaction-id}/files/{file-id}/download 资源发送 GET 请求,以 JSON 格式获取参数值:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download