Contents x
[Post] Create Batch Records
  • 08 Sep 2023
  • 1 Minute to read
  • PDF
Contents

[Post] Create Batch Records

  • Updated on 08 Sep 2023
  • 1 Minute to read
  • PDF
Article Summary

POST  /api/DocBatch/CreateBatchRecords

Required User-Role: BatchCreator


Create multiple batch records from a collection of files and a dictionary of metadata, referenced by filename. Each batch record within the collection contains the payload of a document for processing. Validation of the payload can be started immediately by enabling the immediatelyReadyForValidation parameter. Alternatively, validation can be started explicitly by calling /api/DocBatch/MarkBatchRecordReadyForValidation. In either case, validation is performed asynchronously while the batch is still accepting new batch records. 

The maximum payload size for batch record uploads is 100MB.


Request

POST /api/DocBatch/CreateBatchRecords?tenantGuid={tenantGuid}&batchGuid={batchGuid}&immediatelyReadyForValidation=false
content-type: application/json
authorization: Bearer {token}

See Authentication for more about bearer tokens.

   

Query Parameters

tenantGuid (string($uuid)) Required 
The Guid of the batch tenant associated to the batch.

batchGuid (string($uuid)) Required
Unique Guid of the batch to create the batch records in.

immediatelyReadyForValidation (boolean) Required
Begin validation of the batch records immediately after upload, according to the Batch Type specified for the batch.


Request Body

MetaData (string) 
XML or JSON metadata for the collection of Batch Records.

RecordData(array) 
The data payloads of the batch records.

   

Response

200  Returns the success state and recordId or an error description.

{
  "isSuccess": true,
  "error": "string",
  "result": [
    0
  ]
}

Error Codes

HTTP

401 Unauthorized

403 Forbidden


Was this article helpful?
What's Next