Box Doc Gen job (Full)
A full representation of a Box Doc Gen job.
12345The unique identifier that represent a Box Doc Gen job.
docgen_jobdocgen_job
Value is always docgen_job
Box Doc Gen batch that the job belongs to.
2022-05-11T10:56:11-07:00Time of job creation.
User who created the job.
11446498The unique identifier for this user
useruser
Value is always user
ID of the enterprise.
1910967The unique identifier for this enterprise
enterpriseenterprise
Value is always enterprise
The output file of the job. This property is null until the job is completed.
42037322ID of the object
filefile
Value is always file
File version of the output file. This property is null until the job is completed.
12345The unique identifier that represent a file version.
file_versionfile_version
Value is always file_version
docxType of the generated file.
apiSource of the request.
completedStatus of the job.
Value is one of submitted,completed,failed,completed_with_error,pending
Box Doc Gen template used in the job.
42037322ID of the object
filefile
Value is always file
File version of a template.
12345The unique identifier that represent a file version.
file_versionfile_version
Value is always file_version
Response Example
{
"id": "12345",
"type": "docgen_job",
"batch": {
"id": "12345",
"type": "docgen_batch"
},
"created_at": "2022-05-11T10:56:11-07:00",
"created_by": {
"id": "11446498",
"type": "user"
},
"enterprise": {
"id": "1910967",
"type": "enterprise"
},
"output_file": {
"id": "42037322",
"type": "file"
},
"output_file_version": {
"id": "12345",
"type": "file_version"
},
"output_type": "docx",
"source": "api",
"status": "completed",
"template_file": {
"id": "42037322",
"type": "file"
},
"template_file_version": {
"id": "12345",
"type": "file_version"
}
}