跳轉到主要內容
Vantage API 可讓您存取文件 Skill 與流程技能的參數,並針對特定處理作業變更其值。在一個處理作業中傳遞的技能參數由鍵值字串(string)配對組成。 對於文件 Skill 與流程技能的參數,透過 Vantage API 設定的值將優先於在 Vantage UI 中所設定的值。

變更 Skill Parameter 值

若要透過 Vantage API 變更 Skill Parameter 的值,請依照下列步驟操作:

步驟 1:建立或初始化一個交易

建立一個空的處理作業或使用 launch 方法初始化一個處理作業。為此,請向 transactions 資源傳送 POST 請求:
POST {your-host}/api/publicapi/v1/transactions
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
在要求本文中為 skill 的 Parameter 指定新值,然後執行下列命令:

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 個 key-value skill 參數,每個 key 最多可包含 128 個字元,每個 value 最多可包含 256 個字元。

取得技能 Parameter 值

若要使用 Vantage API 取得 skill 的 Parameter 值,請採用下列任一種方式:

選項 1:直接取得 Skill Parameters

傳送 GET 要求至 transactions/{transaction-id}/skillParameters 資源:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
回應內容如下:
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

選項 2:下載處理作業檔案

傳送 GET 請求到 transactions/{transaction-id}/files/{file-id}/download 資源,以 JSON 格式取得其值:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download