Box Doc Gen job - Box Dev Docs

{
  "id": "12345",
  "type": "docgen_job",
  "batch": {
    "id": "12345",
    "type": "docgen_batch"
  },
  "template_file": {
    "type": "file",
    "id": "42037322"
  },
  "template_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "status": "completed",
  "output_type": "docx",
  "output_file": {
    "type": "file",
    "id": "42037322"
  },
  "output_file_version": {
    "id": "12345",
    "type": "file_version"
  }
}

A standard representation of a Box Doc Gen job.

string

required

The unique identifier that represent a Box Doc Gen job.

Example:

"12345"

type

enum<string>

required

The value will always be docgen_job.

Available options:

docgen_job

Example:

"docgen_job"

batch

Box Doc Gen batch (Base) · object

required

Box Doc Gen batch that the job belongs to.

Show child attributes

template_file

File reference · object

required

Box Doc Gen template used in the job.

Show child attributes

template_file_version

File version (Base) · object

required

File version of a template.

Show child attributes

status

enum<string>

required

Status of the job.

Available options:

submitted,

completed,

failed,

completed_with_error,

pending

Example:

"completed"

output_type

string

required

Type of the generated file.

Example:

"docx"

output_file

File reference · object

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

File reference
OpenAPI 3.0 null schema type

Show child attributes

output_file_version

File version (Base) · object

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

File version (Base)
OpenAPI 3.0 null schema type

Show child attributes

Box Doc Gen batch (Base)

Box Doc Gen job (Base)

⌘I

Documentation Index