POST  /api/DocBatch/CreateBatchRecord
Required User-Role: BatchCreator
Creates a single batch record containing the payload of a document for processing. Validation of the payload is 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/CreateBatchRecord?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 record 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 batch record. |
| RecordData($binary) The data payload for the batch record. |
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