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

Get Box Doc Gen template by ID

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

Lists details of a specific Box Doc Gen template.

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

The ID of a Box Doc Gen template.

レスポンス

application/jsonBox Doc Gen template

Returns a template.

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

テンプレートが見つからない場合、または関連付けられたテンプレートへのアクセス権限がユーザーに与えられていない場合に返されます。

予期しないクライアントエラー。

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

リクエストの例

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

レスポンスの例

{
  "file": {
    "id": "42037322",
    "type": "file"
  },
  "file_name": "Official contract"
}