Box Developerドキュメント

Box Doc Gen job

A standard representation of a Box Doc Gen job.

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
12345

The unique identifier that represent a Box Doc Gen job.

string
docgen_job

docgen_job

次の値に固定: docgen_job

Box Doc Gen batch that the job belongs to.

The output file of the job. This property is null until the job is completed.

42037322

ID of the object

file

file

次の値に固定: file

File version of the output file. This property is null until the job is completed.

12345

ファイルバージョンを表す一意の識別子。

file_version

file_version

次の値に固定: file_version

docx

Type of the generated file.

string
completed

Status of the job.

次の値のいずれか1つ: submitted,completed,failed,completed_with_error,pending

Box Doc Gen template used in the job.

42037322

ID of the object

file

file

次の値に固定: file

File version of a template.

12345

ファイルバージョンを表す一意の識別子。

file_version

file_version

次の値に固定: file_version

レスポンスの例

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