BatchJob

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}

Request

  • Base URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api
  • URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api/platform/data/batchJob/actions/{code}
  • Auth
    HTTP bearer

Path parameters

codestring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

action'Start' | 'Reset' | 'Cancel'

Response

OK

codestring nullable
dateStartedstring date-time nullable
domain'Catalog'
namestring nullable
scheduledDatestring date-time nullable
status'Ready' | 'Pending' | 'Running' | 'Completed' | 'Canceled'
tenantIdinteger

Changes

No recorded changes to this operation across all 1 revision of this API.