Contents x
[Get] Get a Batch
  • 09 Oct 2023
  • 1 Minute to read
  • PDF
Contents

[Get] Get a Batch

  • Updated on 09 Oct 2023
  • 1 Minute to read
  • PDF
Article Summary

GET  /api/DocBatch/GetBatch

Required User-Role: BatchViewer

Gets a specified batch with its associated batch type, status and meta data.


Request

GET /api/DocBatch/GetBatch?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 containing the batch.

batchGuid (string($uuid)) Required 
Unique Guid of the batch.

   

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-28T08:52:16.231Z",
    "hasCreationCompleted": true,
    "totalRecords": 0,
    "completedRecords": 0,
    "errorRecords": 0,
    "validatedRecords": 0,
    "failedValidatedRecords": 0,
    "updatedDate": "2023-08-28T08:52:16.231Z",
    "completedDate": "2023-08-28T08:52:16.231Z",
    "deletedDate": "2023-08-28T08:52:16.231Z",
    "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


Was this article helpful?
What's Next