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

バッチIDを指定してBox Doc Genジョブを取得

get
https://api.box.com/2.0
/docgen_batch_jobs/:batch_id

バッチ内のBox Doc Genジョブのリストを取得します。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header.

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

Box Doc GenのバッチID。

クエリパラメータ

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

レスポンス

application/jsonBox Doc Genジョブ

Box Doc Genのバッチ内のBox Doc Genジョブのリストを返します。

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

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

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

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

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

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

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

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

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

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

get
バッチIDを指定してBox Doc Genジョブを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

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


cURL
curl -i -X GET "https://api.box.com/2.0/docgen_batch_jobs/12345" \
     -H 'box-version: 2025.0' \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);
Python v10
client.docgen.get_docgen_batch_job_by_id_v2025_r0(docgen_batch.id)
.NET v10
await client.Docgen.GetDocgenBatchJobByIdV2025R0Async(batchId: docgenBatch.Id);
Swift v10
try await client.docgen.getDocgenBatchJobByIdV2025R0(batchId: docgenBatch.id)
Java v10
client.getDocgen().getDocgenBatchJobByIdV2025R0(docgenBatch.getId())
.NET v6
await client.Docgen.GetDocgenBatchJobByIdV2025R0Async(batchId: docgenBatch.Id);
Node v4
await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);

レスポンスの例

{
  "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"
}