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

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

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

Box Doc Genジョブの詳細を取得します。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
123

Box Doc GenジョブのID。

レスポンス

application/jsonBox Doc Genジョブ

Box Doc Genジョブの詳細。

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

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

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

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

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

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

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

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

get
IDを指定してBox Doc Genジョブを取得
このドキュメント内で一部の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"
  }
}