メインコンテンツへスキップ
APIバージョン 2025.0 Box Doc GenジョブのStandard版の表示。
このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。
id
string
12345Box Doc Genジョブを表す一意の識別子。
type
string
docgen_job値は常にdocgen_jobになります。次の値に固定: docgen_job
batch
Box Doc Genのバッチ (Base)object
ジョブが属しているBox Doc Genのバッチ。
output_file
object
ジョブの出力ファイル。このプロパティは、ジョブが完了するまでnullとなります。
output_file_version
object
出力ファイルのファイルバージョン。このプロパティは、ジョブが完了するまでnullとなります。
output_type
string
docx生成されたファイルの種類。
status
string
completedジョブのステータス。次の値のいずれか1つ: submitted,completed,failed,completed_with_error,pending
template_file
object
ジョブで使用されたBox Doc Genテンプレート。
template_file_version
object
テンプレートのファイルバージョン。
{
  "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"
  }
}