Get the list of operations

To get the list of created operations, send a GET request to the /operations resource.

Request

GET /api/v1/operations ?
  [type=<operation type>]
& [status=<operation status>]
& [limit=<maximum number of results in the response>]
& [sort=<fields to sort by>]
& [id_gt=<operation ID>]
& [id_gte=<operation ID>]
& [id_lt=<operation ID>]
& [id_lte=<operation ID>]
& [submitted_gt=<date>]
& [submitted_gte=<date>]
& [submitted_lt=<date>]
& [submitted_lte=<date>]
& [finished_gt=<date>]
& [finished_gte=<date>]
& [finished_lt=<date>]
& [finished_lte=<date>]

Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>
Request parameters

Parameter

Description

Data type

Required

type

Operation type:

  • POOL.OPEN — Opening a pool.

  • POOL.CLOSE — Closing a pool.

  • PROJECT.ARCHIVE — Archiving a project.

  • POOL.ARCHIVE — Archiving a pool.

  • TASK_SUITE.BATCH_CREATE — Creating multiple task suites.

String

No

status

The status of the operation:

  • PENDING — Not started yet.

  • RUNNING — In progress.

  • SUCCESS — Completed sucessfully.

  • FAIL — Not completed.

String

No

limit

Limit on the number of results to return. By default — 50; maximum — 500.

Number

No

sort

Parameters for sorting in ascending order:

  • id — Operation ID.

  • submitted — The UTC date and time when the request was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

  • finished — the UTC date and time when the operation was finished, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss]; ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

You can separate parameters with a comma.

To change the sorting direction to descending, add the minus sign before the parameter. For example, sort=-id.

String

No

id_gt

Operations with an ID greater than the specified value.

String

No

id_gte

Operations with an ID greater than or equal to the specified value.

String

No

id_lt

Operations with an ID greater than the specified value.

String

No

id_lte

Operations with an ID less than or equal to the specified value.

String

No

submitted_gt

Operations created after the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

submitted_gte

Operations created after or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

submitted_lt

Operations created before the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

submitted_lte

Operations created before or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

finished_gt

Operations completed after the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

finished_gte

Operations completed after or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

finished_lt

Operations completed before the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

finished_lte

Operations completed before or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

Response

Contains a list of operations in the items array:

{"items": [{information about operation 1}, {information about operation 2}, ... {information about operation n}], "has_more": false}