Perform Batch Action

Performs an action on the specified batch job. Possible actions are start, cancel, and reset actions. Reset can only be called for jobs that are already completed or canceled, and will remove all items so that you can re-use the empty job.

POST /platform/data/batchJob/actions/{code}

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "dateStarted": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "scheduledDate": "2023-11-07T05:31:56Z",
  "tenantId": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

code · string · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

action · enum<string>

Available options: Start, Reset, Cancel

Response

200

application/json

Success

auditInfo · object

Show child attributes

code · string | null

dateStarted · string<date-time> | null

domain · enum<string>

Available options: Catalog

name · string | null

scheduledDate · string<date-time> | null

status · enum<string>

Available options: Ready, Pending, Running, Completed, Canceled

tenantId · integer<int32>