Developers
Operations8

List operations

GET/operations

Lists the asynchronous operations of the current account, using cursor-based pagination.

The collection can be filtered by status and type and sorted by creation date.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "created_at"
  • "-created_at"
status?string

Only operations with this status.

Value in

  • "queued"
  • "running"
  • "succeeded"
  • "partially_succeeded"
  • "failed"
  • "canceled"
type?string

Only operations of this type.

Value in

  • "credential.revoke"
  • "sandbox.reset"
  • "webhook.replay"
  • "product.publish_all"
  • "product.copy"
  • "module.publish_all"
  • "module.copy"
  • "email.send_test"
  • "lesson.copy"
  • "access.apply_all"
  • "sandbox.run_scenario"
  • "configuration.apply"
  • "delivery.apply_tags"
  • "sales_event.reprocess"
  • "diamond.reprocess_membership"
  • "import.analyze"
  • "import.process"
  • "export.generate"

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/operations"
{  "data": [    {      "attempt": {        "number": 0,        "status": "running"      },      "cancellation_requested": true,      "created_at": "2019-08-24T14:15:22Z",      "error": {        "code": "worker_error",        "field": "string",        "message": "string",        "reason": "string",        "resource_id": "string"      },      "expires_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "id": "string",      "items_url": "string",      "object": "operation",      "progress": {        "done": 0,        "failed": 0,        "total": 0      },      "result_url": "string",      "started_at": "2019-08-24T14:15:22Z",      "status": "queued",      "type": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Operations8

Operations in API v3: list operations, create a batch operation, retrieve an operation, cancel an operation, list operation attempts, resume an operation, retrieve an operation attempt, list operation items.

Create a batch operation POST

Creates an asynchronous batch operation. All items in the batch are processed with the same operation `type`, which also determines the structure of each item's `payload`. The operation is accepted with a `Location` header pointing to it and processed asynchronously. Poll the retrieve operation to track its progress. In addition to `operations.manage`, the credential must have the permission required by the selected operation type. Repeating the request with the same `Idempotency-Key` returns the same operation instead of creating a new one. The request is rejected with `operation_type_unknown` for an unsupported type, `duplicate_item_key` when item keys are not unique, `too_many_items` when the batch exceeds the maximum number of items for the type, and `operation_backlog_exceeded` when the account has too many unfinished operations.