Box Developerドキュメント
最新バージョン

List all Box Doc Gen template tags in template

get
https://api.box.com/2.0
/docgen_templates/:template_id/tags

Lists all tags in a Box Doc Gen template.

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

ID of template.

クエリパラメータ

integer (int64)クエリ内省略可能
1000
1000

返す項目の1ページあたりの最大数。

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkertrueに設定する必要があります。

stringクエリ内省略可能
123

Id of template version.

レスポンス

application/jsonBox Doc Gen tags

A list of document generation template tags.

Processing tags for the file.

The client does not have access rights to the content or resource requested.

The requested resource could not be found but may be available in the future.

The user has sent too many requests in a given amount of time.

An unexpected condition was encountered on the server.

get
List all Box Doc Gen template tags in template
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -L 'https://api.box.com/2.0/docgen_templates/12345678/tags' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
TypeScript Gen
await client.docgenTemplate.getDocgenTemplateTagsV2025R0(
  fetchedDocgenTemplate.file!.id,
);
Python Gen
client.docgen_template.get_docgen_template_tags_v2025_r0(
    fetched_docgen_template.file.id
)
.NET Gen
await client.DocgenTemplate.GetDocgenTemplateTagsV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);

レスポンスの例

{
  "entries": [
    {
      "json_paths": [
        "products",
        "products.name"
      ],
      "tag_content": "{{item.name}}",
      "tag_type": "text"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}