メインコンテンツへスキップ
Vantage API を使用すると、特定のトランザクションに対して Document skill と Process skill のパラメーターにアクセスし、その値を変更できます。トランザクションで渡される Skill のパラメーターは、キーと値の string のペアで構成されます。 Document skill と Process 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"}]}'
注意: キーと値のSkill Parameterは最大10個まで使用できます。各キーは最大128文字、各値は最大256文字まで指定できます。

​
Skill の Parameter 値を取得する

Vantage API を使用して Skill の Parameter 値を取得するには、次のいずれかの方法を実行します。

​
オプション 1: Skill の Parameter を直接取得

transactions/{transaction-id}/skillParameters リソースに GET リクエストを送信します。 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
レスポンスは次のようになります： 
[
  {
    "key": "新しいParameter",
    "value": "Vendors"
  }
]

​
オプション 2: トランザクション ファイルをダウンロード

JSON 形式で値を取得するには、transactions/{transaction-id}/files/{file-id}/download リソースに GET リクエストを送信します。 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download