Box Doc Genテンプレート

Box Doc Gen APIを使用すると、Box Doc Genテンプレートに関連した情報を取得できます。

前提条件

Box Doc Gen APIの使用を開始する前に、Box Doc Genの使い方ガイドに記載されている手順に従って、PlatformアプリとBox Doc Genテンプレートを作成してください。

作成されたすべてのBox Doc Genテンプレートのリストを取得するには、GET /2.0/docgen_templatesエンドポイントを使用します。追加のパラメータを指定する必要はありません。

curl -L 'https://api.box.com/2.0/docgen_templates' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

レスポンスには、すでに作成済みのBox Doc Genテンプレートを列挙するentries配列が含まれます。

特定のBox Doc Genテンプレートを取得するには、GET /2.0/docgen_templates_idエンドポイントを使用し、template_idを指定します。

curl -L 'https://api.box.com/2.0/docgen_templates/12345678' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

レスポンスには、Box Doc Genテンプレートとして使用されたファイルの詳細が含まれます。

作成済みのすべてのBox Doc Genテンプレートのリストを取得するには、GET /2.0/docgen_template_jobs_idエンドポイントを使用し、template_idを指定します。

curl -L 'https://api.box.com/2.0/docgen_template_jobs/12345678' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

レスポンスには、ドキュメントを生成するために実行されたBox Doc Genジョブのリストが含まれます。