メインコンテンツへスキップ
GET
/
docgen_batch_jobs
/
{batch_id}
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>"
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "12345",
      "type": "docgen_job",
      "batch": {
        "id": "12345",
        "type": "docgen_batch"
      },
      "template_file": {
        "type": "file",
        "id": "42037322"
      },
      "template_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "status": "completed",
      "output_type": "docx",
      "output_file": {
        "type": "file",
        "id": "42037322"
      },
      "output_file_version": {
        "id": "12345",
        "type": "file_version"
      }
    }
  ]
}
「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
box-version
enum<string>
required

Version header.

利用可能なオプション:
2025.0

Path Parameters

​
batch_id
string
required

Box Doc GenのバッチID。

Query Parameters

​
marker
string

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

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

​
limit
integer<int64>

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

必須範囲: x <= 1000

Response

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

標準のパラメータのセットを含むBox Doc Genジョブのリスト。 マーカーベースのページネーションについて説明しているAPIレスポンスの部分。

​
limit
integer<int64>

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

Example:

1000

​
next_marker
string | null

次の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

前の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
entries
Box Doc Genジョブ · object[]

ジョブのリスト。