Box Developer Documentation
Log in

Box Doc Gen job

A standard representation of a Box Doc Gen job.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
12345

The unique identifier that represent a Box Doc Gen job.

string
docgen_job

The value will always be docgen_job.

Value is always docgen_job

Box Doc Gen batch (Base) object

Box Doc Gen batch that the job belongs to.

object

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

string
42037322

ID of the object.

string
file

The value will always be file.

Value is always file

object

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

string
12345

The unique identifier that represent a file version.

string
file_version

The value will always be file_version.

Value is always file_version

string
docx

Type of the generated file.

string
completed

Status of the job.

Value is one of submitted,completed,failed,completed_with_error,pending

object

Box Doc Gen template used in the job.

string
42037322

ID of the object.

string
file

The value will always be file.

Value is always file

object

File version of a template.

string
12345

The unique identifier that represent a file version.

string
file_version

The value will always be file_version.

Value is always file_version

Response Example

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