Taxonomy

cancelBulkAction

Cancels a running bulk action job. The job status will be updated to CANCELLED and the job will be stopped.

post/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel

Request

  • Base URL
    https://entity.sls.epilot.io
  • URL
    https://entity.sls.epilot.io/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Path parameters

job_idstring required

Job ID of the bulk operation to cancel

Response

Success

job_idstring uuid
job_status'PENDING' | 'FAILED' | 'COMPLETED' | 'CANCELLED'

The status of the bulk job

failure_reasonstring
action_type'MOVE_CLASSIFICATIONS' | 'MERGE_CLASSIFICATIONS' | 'DELETE_CLASSIFICATIONS'
created_bystring
created_atstring date-time
updated_atstring date-time
orgstring

Example response

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "PENDING",
  "action_type": "MOVE_CLASSIFICATIONS",
  "created_by": "10598",
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "org": "66"
}

Changes

No recorded changes to this operation across all 18 revisions of this API.