Vantage API を介した Skill Parameter へのアクセス

Vantage API を使用すると、特定のトランザクションに対して Document と Process skill の Skill Parameter にアクセスし、その値を変更できます。パラメーターは、キーと値の string のペアとして渡されます。API で設定された値が Vantage UI で設定された値よりも優先されます。

Skill Parameter の値を変更する

トランザクションの Skill Parameter の値を変更するには、POST リクエストでトランザクションを作成または起動します。その際、リクエストボディの skillParameters field に新しい値を指定します。空のトランザクションを作成するには、次のリクエストを送信します。

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

特定のSkillを実行するトランザクションを開始するには、次のリクエストを送信します。

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

次の例では、リクエストボディに新しいパラメーター値を含めています。

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

1 つのトランザクションには、キーと値のペアからなる skill parameter を最大 10 個含めることができます。キーは 128 文字まで、値は 256 文字までです。

Skill Parameter 値を取得する

次のいずれかのメソッドを使用して Skill Parameter 値を取得します。

skillParameters エンドポイントにクエリを実行する

GET リクエストを送信します：

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

レスポンスの例：

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

トランザクションファイルをダウンロード

JSON 形式のパラメーター値を含むトランザクションファイルをダウンロードするには、GET リクエストを送信します。

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

​Skill Parameter の値を変更する

​Skill Parameter 値を取得する

​skillParameters エンドポイントにクエリを実行する

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

​関連トピック

Skill Parameter の値を変更する

Skill Parameter 値を取得する

skillParameters エンドポイントにクエリを実行する

トランザクションファイルをダウンロード

関連トピック