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

[Post] Search Batch Records

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

POST  /api/DocBatch/SearchBatchRecords

Required User-Role: BatchViewer

Searches for batch records within a batch and returns a subset by a specified criteria. You can also specify the size of the result set, e.g. 100 records.


Request

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

{
  "pageIndex": 0,
  "pageSize": 0,
  "status": "Creating",
  "retrieved": true,
  "recordReference": "string",
  "searchFromDate": "2023-08-29T06:20:24.870Z",
  "searchToDate": "2023-08-29T06:20:24.870Z"
}

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 search.

   

Response

200  Returns the success state and batch records or an error description.

{
  "isSuccess": true,
  "error": "string",
  "result": {
    "batchRecords": [
      {
        "batchRecordId": 0,
        "batchGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "batchRecordReference": "string",
        "createdDate": "2023-08-29T06:20:24.871Z",
        "completedDate": "2023-08-29T06:20:24.871Z",
        "statusId": "Creating",
        "updatedDate": "2023-08-29T06:20:24.871Z",
        "hasLogData": true,
        "hasDocumentData": true,
        "isRetrieved": true,
        "metaData": "string"
      }
    ],
    "pageIndex": 0,
    "pageSize": 0,
    "total": 0
  }
}

Error Codes

HTTP

401 Unauthorized

403 Forbidden


Was this article helpful?
What's Next