> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

> Vantage API を使用して、Document と Process Skill Parameter 値にアクセスして変更

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

<div id="change-skill-parameter-values">
  ## Skill Parameter の値を変更する
</div>

トランザクションの Skill Parameter の値を変更するには、POST リクエストで新しいトランザクションを作成 (または起動) し、`skillParameters` を含むリクエストボディに新しい値を指定します。

空のトランザクションを作成します。

```http theme={null}
POST {your-host}/api/publicapi/v1/transactions
```

または、特定のSkillを実行するトランザクションを開始します。

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

リクエスト本文に新しいパラメーター値を含めます:

<Tabs>
  <Tab title="Windows">
    ```bat theme={null}
    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\"}]}"
    ```
  </Tab>

  <Tab title="Linux">
    ```bash theme={null}
    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"}]}'
    ```
  </Tab>
</Tabs>

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

<div id="get-skill-parameter-values">
  ## Skill Parameter 値を取得する
</div>

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

<div id="query-the-skillparameters-endpoint">
  ### skillParameters エンドポイントにクエリを実行する
</div>

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

```http theme={null}
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
```

レスポンス：

```json theme={null}
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]
```

<div id="download-the-transaction-file">
  ### トランザクション ファイルをダウンロード
</div>

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

```http theme={null}
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download
```

<div id="related-topics">
  ## 関連トピック
</div>

* [Skill Parameter](/ja/vantage/documentation/skill-designer/skill-parameters/skill-parameters)
* [Document Skill Parameter](/ja/vantage/documentation/skill-designer/skill-parameters/document-skill-params)
* [Process Skill Parameter](/ja/vantage/documentation/skill-designer/skill-parameters/process-skill-params)
* [Extract アクティビティ](/ja/vantage/documentation/skill-designer/process/extract-activity)
* [API の概要](/ja/vantage/developer/api-introduction)
