Получить список операций

GET /operations

Получает список созданных операций.

Запрос

cURL

Python

Nodejs

curl -X GET 'https://tasks.yandex.ru/api/v1/operations' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/operations"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/operations',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок	Описание
`Authorization`	API-токен для авторизации аккаунта. В качестве префикса добавьте `OAuth`.

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр	Описание
`type`	string Тип операции: `ANALYTICS` — получение аналитических данных; `POOL.ARCHIVE` — отправка пула в архив; `POOL.CLONE` — клонирование пула; `POOL.CLOSE` — закрытие пула; `POOL.OPEN` — открытие пула; `PROJECT.ARCHIVE` — отправка проекта в архив; `SOLUTION.AGGREGATE` — агрегация результатов; `TASK.BATCH_CREATE` — создание нескольких заданий; `TASK_SUITE.BATCH_CREATE` — создание нескольких страниц заданий; `TRAINING.ARCHIVE` — отправка обучающего пула в архив; `TRAINING.CLONE` — клонирование обучающего пула; `TRAINING.CLOSE` — закрытие обучающего пула; `TRAINING.OPEN` — открытие обучающего пула; `USER_BONUS.BATCH_CREATE` — выдача нескольких бонусов исполнителям.
`status`	string Статус операции: `PENDING` — выполнение не началось; `RUNNING` — выполняется; `SUCCESS` — успешно выполнена; `FAIL` — не выполнена.
`sort`	string Параметры для сортировки: `id` — идентификатор операции; `submitted` — дата и время отправки запроса по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`; `finished` — дата и время завершения операции по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`. О том, как задать сортировку, читайте на странице Сортировка списка объектов.
`limit`	integer Ограничение на количество возвращаемых результатов. По умолчанию — 50, максимум — 500.
`id_gt`	string Объекты с идентификатором больше указанного значения.
`id_gte`	string Объекты с идентификатором больше или равным указанному значению.
`id_lt`	string Объекты с идентификатором меньше указанного значения.
`id_lte`	string Объекты с идентификатором меньше или равным указанному значению.
`submitted_gt`	string Объекты, выданные или созданные после указанной даты.
`submitted_gte`	string Объекты, выданные или созданные после указанной даты включительно.
`submitted_lt`	string Объекты, выданные или созданные до указанной даты.
`submitted_lte`	string Объекты, выданные или созданные до указанной даты включительно.
`finished_gt`	string Объекты, завершенные после указанной даты.
`finished_gte`	string Объекты, завершенные после указанной даты включительно.
`finished_lt`	string Объекты, завершенные до указанной даты.
`finished_lte`	string Объекты, завершенные до указанной даты включительно.

Ответ

Содержит список операций в массиве items:

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

Пример ответа

[
  {
    "items": [
      {
        "id": "07700135-c34a-4df0-ae55-d44081dea432",
        "type": "ANALYTICS",
        "status": "SUCCESS",
        "submitted": "2022-11-22T16:11:38.874",
        "started": "2022-11-22T16:11:39.005",
        "finished": "2022-11-22T16:11:39.633",
        "progress": 100,
        "parameters": {
          "value": [
            {
              "name": "completion_percentage",
              "subject": "POOL",
              "subject_id": "36502086"
            }
          ]
        },
        "details": {
          "value": [
            {
              "result": {
                "type": "NORMAL",
                "value": 96,
                "infinite": false,
                "approximate": false
              },
              "request": {
                "name": "completion_percentage",
                "subject": "POOL",
                "subject_id": "36502086"
              },
              "finished": "2022-11-22T16:11:39.348"
            }
          ]
        }
      }
    ],
    "has_more": true
  }
]

Параметр

Описание

items

array of objects

Массив со списком операций и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

true — не все элементы вошли в ответ из-за ограничений в параметре limit.

Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

См. подробнее о фильтрации запросов.
false — в ответе содержатся все имеющиеся элементы.

Была ли статья полезна?

Отслеживание операций

Получить сведения об операции