PUT  /api/DocBatch/ApproveBatch
Required User-Role: BatchCreator
Approving a batch marks it ready for processing. This step is redundant when the Batch Type associated to the batch was configured to process records without approval. See Configuring a Batch Type for more information.
Request
PUT /api/DocBatch/ApproveBatch?tenantGuid={tenantGuid}&batchGuid={batchGuid}
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 approve. |
Response
200  Returns the success state and the batch or an error description.
{
"isSuccess": true,
"error": "string",
"result": {
"batchGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2023-08-31T11:23:49.146Z",
"hasCreationCompleted": true,
"totalRecords": 0,
"completedRecords": 0,
"errorRecords": 0,
"validatedRecords": 0,
"failedValidatedRecords": 0,
"updatedDate": "2023-08-31T11:23:49.146Z",
"completedDate": "2023-08-31T11:23:49.146Z",
"deletedDate": "2023-08-31T11:23:49.146Z",
"statusId": "Creating",
"hasData": true,
"hasLogData": true,
"hasDocumentData": true,
"batchType": {
"batchTypeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"configuration": {
"processRecordsWithoutApproval": true,
"performMerge": true,
"batchCompletionIgnoresRecordsInError": true,
"purgeTimeSpan": "string",
"dataType": "Xml",
"dataSchemaBase64": "string",
"referenceDataPath": "string",
"templateGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"templateVersion": "string",
"chainGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chainVersion": "string",
"workflowProcessGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workflowProcessVersion": "string",
"timeout": "string",
"parameters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
},
"batchReference": "string"
}
}Error Codes
HTTP
401 Unauthorized
403 Forbidden