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

Get Box Doc Gen jobs in a batch with a specific ID

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

Lists Box Doc Gen jobs in a batch

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

Box Doc Gen batch ID.

クエリパラメータ

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

レスポンス

application/jsonBox Doc Gen jobs

Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.

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

The client does not have access rights to the content or resource requested.

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

Returned if the batch is not found or the user does not have access to the associated batch.

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

The user has sent too many requests in a given amount of time.

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

An unexpected condition was encountered on the server.

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

リクエストの例

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>"
TypeScript Gen
await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);
Python Gen
client.docgen.get_docgen_batch_job_by_id_v2025_r0(docgen_batch.id)
.NET Gen
await client.Docgen.GetDocgenBatchJobByIdV2025R0Async(batchId: 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"
}