v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Operations

List all bulk operations

🔑

Required OAuth scope: bulkOperations:read.

📖

This endpoint is paginated with a page size of 20 bulk operations. For more information, see the Pagination guide.

Lists all bulk operations.

get/api/v2/bulk/operations

Query parameters

ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on createdAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}

eq'pending' | 'queued' | 'running' | 'completed' | 'error'

Filter on values equal to the given one

Filter on status property with LHS bracket notation.

Expected value format is a string (pending, queued, running, completed, error).

{
  "eq": "pending"
}

Filter on values equal to the given one

Filter on type property with LHS bracket notation.

Expected value format is a string (addContentsToGroupsCatalog, addContentsToGroupsLibrary, addSkillReviews, addUsersToGroups, archiveExternalCourses, deleteSkills, createGroups, createSubscriptionEvents, deleteGroups, deleteJobs, deleteLibraries, importExternalCourses, importExternalStatistics, removeContentsFromGroupsCatalog, removeContentsFromGroupsLibrary, removeUsersFromGroups, replaceJobsSkills, replaceUsersJobs, upsertJobs, upsertLibraries, upsertSkills).

{
  "eq": "addContentsToGroupsCatalog"
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 20 bulk operations.

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011"
  }
]