Working with Batches via API

Batches function as repositories that accommodate any quantity of document payloads (Batch Records) for processing. They are associated to a Batch Type that specifies the DocFusion template to use when validating and processing Batch Records within the batch. Once processed, batches can be searched to retrieve Batch Records with their associated payloads and processing logs. 

Batch Usage via API

Please note that all API flows require the creation and setup of Batch Types first. For more information, read Configuring a Batch Type. 

Setup Batch Processing 

Insert a new Batch Type to define the batch records within a batch and how they are validated. 

1. Plan Batch Type configuration
2. Insert a Batch Type
    

Creating & Processing Batches 

Creates the batch container and adds batch records for validation and processing.

1. Create a Batch
2. Create Batch Records
3. Mark Batch Records Ready For Validation
4. Mark Batch As Complete
5. Approve Batch (Optional, based on the Batch Type configuration)

Searching Batches 

Locates batch records within a batch using specified criteria to monitor status information. 

1. Get a Batch
2. Search Batch Records
3. Get Batch Record

Retrieving Documents

Retrieving processed batch records that contain document payloads.

1. Get a Batch
2. Get Batch Record
3. Get Batch Record Document
4. Set Batch Record as Retrieved

Resolving Generation Errors

Retrieving and using batch record logs to correct processing errors, then re-submit updated batch records.

1. Get a Batch
2. Search Batch Records
3. Get Batch Record Log
4. Update Batch Record Data
5. Retry Processing of Batch Record