Taxonomy

getTaxonomyBulkActionJobs

Gets bulk actions jobs by job status:

  • <undefined> = all active jobs
  • PENDING = all active jobs
  • FAILED = all failed jobs
  • COMPLETED = all completed jobs
get/v1/entity/taxonomies/bulk-jobs

Request

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

Query parameters

statusstring[]

A comma separated list of job statuses to return

The status of the jobs to return

sizenumber

The maximum number of jobs to return (defaults to 20)

created_afterstring date-time

ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).

Example:2023-01-01T00:00:00.000Z
sort_pending_firstboolean

When true, sorts PENDING status jobs to the top of the results.

scope'me' | 'all'

Scope of jobs to return. 'me' returns only jobs created by the current user, 'all' returns jobs from all users in the organization.

Response

Returns the jobs matching the given query or the active jobs if no status is provided

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.