Start batch

To start a batch using the REST interface, use the details mentioned in the following table. However, before you start a batch, obtain the following permissions:

  • PERM_START_BATCH
  • PERM_READ_BATCH

HTTP Method

POST

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

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

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Cardinality Description
batchId string Mandatory The ID of the batch to start must be unique.

Response Model

{
  "result": {
    "code": {
      "severity": "Success",
      "message": "Success.",
      "code": "0000"
    },
    "params": [],
    "message": "Success."
  },
  "data": null,
  "startTimestampMS": 1659602211924,
  "duration": 9
}