Get batch

Use the following details to complete a batch using the REST interface:

HTTP Method

GET

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/restapi/v1/read-batch/{batchId}

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Cardinality Description
batchId array[string] Mandatory

The ID of the batch to start must be unique. There can be multiple strings for batchId.

Response Model

{
  "result": {
    "code": {
      "severity": "Success",
      "message": "Success.",
      "code": "0000"
    },
    "params": [],
    "message": "Success."
  },
  "data": {
    "batch": [
      {
        "entity": {
          "id": "1",
          "ownedBy": "admin",
          "createdBy": "admin",
          "createdDate": "2022-08-04T08:35:15.417+0000",
          "lastUpdatedBy": null,
          "lastUpdatedDate": null,
          "entities": null
        },
        "message": "Success."
      }
    ],
    "resultStatus": "Successfully get data."
  },
  "startTimestampMS": 1659602731239,
  "duration": 25
}