Box Developerドキュメント
ログイン

BoxWorks 2024でコンテンツとAIの可能性について紹介します。

最新バージョン

テンプレートのすべてのBox Doc Genジョブのリストを取得

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

このテンプレートを使用するユーザーのジョブのリストを取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header.

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

ジョブの取得対象となるテンプレートのID。

クエリパラメータ

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

レスポンス

application/jsonBox Doc Genジョブ

1つのBox Doc Genテンプレート。

application/jsonクライアントエラー

ユーザーが形式の正しくないマーカーや限界値を渡した場合に返されます。

application/jsonクライアントエラー

クライアントには、リクエストされたコンテンツまたはリソースへのアクセス権限がありません。

application/jsonクライアントエラー

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

application/jsonクライアントエラー

ユーザーが一定時間内に送信したリクエストが多すぎます。

application/jsonクライアントエラー

サーバーで予期しない状況が発生しました。

get
テンプレートのすべてのBox Doc Genジョブのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -L 'https://api.box.com/2.0/docgen_template_jobs/12345678' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
Node/TypeScript v10
await client.docgenTemplate.getDocgenTemplateJobByIdV2025R0(
  fetchedDocgenTemplate.file!.id,
);
Python v10
client.docgen_template.get_docgen_template_job_by_id_v2025_r0(
    fetched_docgen_template.file.id
)
.NET v10
await client.DocgenTemplate.GetDocgenTemplateJobByIdV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);
Swift v10
try await client.docgenTemplate.getDocgenTemplateJobByIdV2025R0(templateId: fetchedDocgenTemplate.file!.id)
Java v10
client.getDocgenTemplate().getDocgenTemplateJobByIdV2025R0(fetchedDocgenTemplate.getFile().getId())

レスポンスの例

{
  "entries": [
    {
      "id": "12345",
      "type": "docgen_job",
      "batch": {
        "id": "12345",
        "type": "docgen_batch"
      },
      "output_file": {
        "id": "42037322",
        "type": "file"
      },
      "output_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "output_type": "docx",
      "status": "completed",
      "template_file": {
        "id": "42037322",
        "type": "file"
      },
      "template_file_version": {
        "id": "12345",
        "type": "file_version"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}