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

    Get Box Doc Gen jobs by batch ID

    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

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

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

    レスポンス

    application/jsonBox Doc Genジョブ

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

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

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

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

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

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

    get
    Get Box Doc Gen jobs by batch 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>"

    レスポンスの例

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