最新バージョン
テンプレート内のすべてのBox Doc Genテンプレートタグのリストを取得
APIバージョン 2025.0
Box Doc Genテンプレート内のすべてのタグのリストを取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
リクエストヘッダー
string ヘッダー内必須
Version header.
次の値に固定: 2025.0
パスパラメータ
stringパス内必須
123テンプレートのID。
クエリパラメータ
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページネーションを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
stringクエリ内省略可能
123テンプレートバージョンのID。
レスポンス
application/jsonBox Doc Genタグ
ドキュメント生成テンプレートタグのリスト。
application/jsonBox Doc Genタグの処理メッセージ
ファイルのタグを処理しています。
application/jsonクライアントエラー
ユーザーが形式の正しくないマーカーや限界値を渡した場合に返されます。
application/jsonクライアントエラー
クライアントには、リクエストされたコンテンツまたはリソースへのアクセス権限がありません。
application/jsonクライアントエラー
リクエストされたリソースは見つかりませんが、将来使用できる可能性があります。
application/jsonクライアントエラー
ユーザーが一定時間内に送信したリクエストが多すぎます。
application/jsonクライアントエラー
サーバーで予期しない状況が発生しました。
リクエストの例
cURL
curl -L 'https://api.box.com/2.0/docgen_templates/12345678/tags' \
-H 'box-version: 2025.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'Node/TypeScript v10
await client.docgenTemplate.getDocgenTemplateTagsV2025R0(
fetchedDocgenTemplate.file!.id,
);Python v10
client.docgen_template.get_docgen_template_tags_v2025_r0(
fetched_docgen_template.file.id
).NET v10
await client.DocgenTemplate.GetDocgenTemplateTagsV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);Swift v10
try await client.docgenTemplate.getDocgenTemplateTagsV2025R0(templateId: fetchedDocgenTemplate.file!.id)Java v10
client.getDocgenTemplate().getDocgenTemplateTagsV2025R0(fetchedDocgenTemplate.getFile().getId()).NET v6
await client.DocgenTemplate.GetDocgenTemplateTagsV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);Node v4
await client.docgenTemplate.getDocgenTemplateTagsV2025R0(
fetchedDocgenTemplate.file!.id,
);レスポンスの例
{
"entries": [
{
"json_paths": [
"products",
"products.name"
],
"tag_content": "{{item.name}}",
"tag_type": "text"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}