Get operation details

Attention

The toloka.yandex.com domain will be disabled starting July 1, 2023. Please use the toloka.dev domain for API requests.

Gets operation details.

Request

Tip

Try our new API reference: more parameter details, request/response examples, and code samples in various programming languages, including the Toloka-Kit usage samples.

Production version

Sandbox

GET https://toloka.dev/api/v1/operations/<operation_id>
Authorization: OAuth <OAuth token>

Path parameters

Parameter	Overview
operation_id	Operation ID.

Headers

Title	Overview
Authorization	A token for account authorization. Add OAuth as a prefix.

Response

Contains operation details in JSON format (see the example in the Operations section).

{
  "id" : "57068577e4b0bf7b07a0256f",
  "type" : "TASK_SUITE.BATCH_CREATE",
  "status" : "FAIL",
  "submitted" : "2016-04-07T16:06:15.902",
  "started" : "2016-04-07T16:06:15.902",
  "finished" : "2016-04-07T16:06:15.902",
  "progress" : 100,
  "parameters" : {
    "open_pool" : false,
    "allow_defaults" : false,
    "skip_invalid_items" : false
  },
  "details" : {
    "total_count" : 2,
    "valid_count" : 0,
    "failed_count" : 2,
    "success_count" : 0,
    "not_valid_count" : 2
  }
}

Parameter	Overview
id	string \| required Operation ID.
type	string \| required Operation type: `POOL.OPEN` — Opening a pool. `POOL.CLOSE` — Closing a pool. `PROJECT.ARCHIVE` — Archiving a project. `POOL.ARCHIVE` — Archiving a pool. `SOLUTION.AGGREGATE` — Aggregating responses. `TASK_SUITE.BATCH_CREATE` — Creating multiple task suites. `KNOWN_SOLUTIONS.GENERATE` — Generating control tasks.
status	string \| required The status of the operation: `PENDING` — Not started yet. `RUNNING` — In progress. `SUCCESS` — Completed successfully. `FAIL` — Not completed. Displayed for all operations except poll creation.
submitted	string \| required The UTC date and time the request was sent, in ISO 8601 format: `YYYY-MM-DDThh:mm:ss[.sss]`.
started	string The UTC date and time the operation started, in ISO 8601 format: `YYYY-MM-DDThh:mm:ss[.sss]`.
finished	string The UTC date and time the operation finished, in ISO 8601 format: `YYYY-MM-DDThh:mm:ss[.sss]`.
progress	integer The percentage of the operation completed.
parameters	JSON Operation parameters (depending on the operation type).
details	JSON Details of the operation completion.