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

Get Box Doc Gen job by ID

get
https://api.box.com/2.0
/docgen_jobs/:job_id

Get details of the Box Doc Gen job.

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

Box Doc Gen job ID.

レスポンス

application/jsonBox Doc Gen job

Details of the Box Doc Gen job.

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

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

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

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

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 job by ID
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/docgen_jobs/12345" \
     -H 'box-version: 2025.0' \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.docgen.getDocgenJobByIdV2025R0(docgenJobs.entries![0].id);
Python Gen
client.docgen.get_docgen_job_by_id_v2025_r0(docgen_jobs.entries[0].id)
.NET Gen
await client.Docgen.GetDocgenJobByIdV2025R0Async(jobId: NullableUtils.Unwrap(docgenJobs.Entries)[0].Id);

レスポンスの例

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