Skip to content

Latest commit

 

History

History
126 lines (75 loc) · 3.36 KB

docgen.md

File metadata and controls

126 lines (75 loc) · 3.36 KB

DocgenManager

Get Box Doc Gen job by ID

Get details of the Box Doc Gen job.

This operation is performed by calling function getDocgenJobByIdV2025R0.

See the endpoint docs at API Reference.

client.getDocgen().getDocgenJobByIdV2025R0(docgenJobItemFromList.getId())

Arguments

  • jobId String
    • Box Doc Gen job ID. Example: 123
  • headers GetDocgenJobByIdV2025R0Headers
    • Headers of getDocgenJobByIdV2025R0 method

Returns

This function returns a value of type DocGenJobV2025R0.

Details of the Box Doc Gen job.

List all Box Doc Gen jobs

Lists all Box Doc Gen jobs for a user.

This operation is performed by calling function getDocgenJobsV2025R0.

See the endpoint docs at API Reference.

client.getDocgen().getDocgenJobsV2025R0(new GetDocgenJobsV2025R0QueryParams.Builder().limit(10000L).build())

Arguments

  • queryParams GetDocgenJobsV2025R0QueryParams
    • Query parameters of getDocgenJobsV2025R0 method
  • headers GetDocgenJobsV2025R0Headers
    • Headers of getDocgenJobsV2025R0 method

Returns

This function returns a value of type DocGenJobsFullV2025R0.

A list of Box Doc Gen jobs.

Get Box Doc Gen jobs by batch ID

Lists Box Doc Gen jobs in a batch.

This operation is performed by calling function getDocgenBatchJobByIdV2025R0.

See the endpoint docs at API Reference.

client.getDocgen().getDocgenBatchJobByIdV2025R0(docgenBatch.getId())

Arguments

  • batchId String
    • Box Doc Gen batch ID. Example: 123
  • queryParams GetDocgenBatchJobByIdV2025R0QueryParams
    • Query parameters of getDocgenBatchJobByIdV2025R0 method
  • headers GetDocgenBatchJobByIdV2025R0Headers
    • Headers of getDocgenBatchJobByIdV2025R0 method

Returns

This function returns a value of type DocGenJobsV2025R0.

Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.

Generate document using Box Doc Gen template

Generates a document using a Box Doc Gen template.

This operation is performed by calling function createDocgenBatchV2025R0.

See the endpoint docs at API Reference.

client.getDocgen().createDocgenBatchV2025R0(new DocGenBatchCreateRequestV2025R0(new FileReferenceV2025R0(uploadedFileDocx.getId()), "api", new DocGenBatchCreateRequestV2025R0DestinationFolderField(folder.getId()), "pdf", Arrays.asList(new DocGenDocumentGenerationDataV2025R0("test", mapOf(entryOf("abc", "xyz"))))))

Arguments

  • requestBody DocGenBatchCreateRequestV2025R0
    • Request body of createDocgenBatchV2025R0 method
  • headers CreateDocgenBatchV2025R0Headers
    • Headers of createDocgenBatchV2025R0 method

Returns

This function returns a value of type DocGenBatchBaseV2025R0.

The created Batch ID.