API version 2025.0
A full 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 full variant can be returned
by API endpoints that support the fields parameter. For example,
by defining the fields request parameter as
id,type when requesting a file by ID, only those fields will
be returned in the API response.
example: 12345 The unique identifier that represent a Box Doc Gen job.
example: docgen_job The value will always be docgen_job. Value is always docgen_job
batch
Box Doc Gen batch (Base)object
Box Doc Gen batch that the job belongs to.
example: 2022-05-11T10:56:11-07:00 Time of job creation.
User who created the job. example: 11446498 The unique identifier for this user.
example: user The value will always be user. Value is always user
ID of the enterprise. example: 1910967 The unique identifier for this enterprise.
example: enterprise The value will always be enterprise. Value is always enterprise
The output file of the job. This property is null until the job is completed. example: 42037322 ID of the object.
example: file The value will always be file. Value is always file
File version of the output file. This property is null until the job is completed. example: 12345 The unique identifier that represent a file version.
example: file_version The value will always be file_version. Value is always file_version
example: docx Type of the generated file.
example: api Source of the request.
example: completed Status of the job. Value is one of submitted,completed,failed,completed_with_error,pending
Box Doc Gen template used in the job. example: 42037322 ID of the object.
example: file The value will always be file. Value is always file
File version of a template. example: 12345 The unique identifier that represent a file version.
example: file_version The value will always be file_version. Value is always file_version
{ "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" } }
