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

GET /operations/{id}

Получает сведения об операции, ID которой указан в запросе.

Можно получить идентификатор ({id}) из списка операций.

Запрос

cURL

Python

Nodejs

curl -X GET 'https://tasks.yandex.ru/api/v1/operations/5c04458e-63c1-46c1-ba0d-6f0756a5358b' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/operations/5c04458e-63c1-46c1-ba0d-6f0756a5358b"
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/5c04458e-63c1-46c1-ba0d-6f0756a5358b',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

Идентификатор операции.

Заголовки

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

Ответ

Содержит сведения об операции в формате JSON.

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

[
  {
    "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"
        }
      ]
    }
  }
]

Параметр	Описание
`id`	string Идентификатор операции.
`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` — не выполнена. Отображается для всех операций, кроме создания пула.
`submitted`	string Дата и время отправки запроса по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`.
`started`	string Дата и время начала операции по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`.
`finished`	string Дата и время завершения операции по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`.
`progress`	integer Ход выполнения операции в процентах.
parameters	object Параметры операции (зависят от типа операции). Полный список параметров приведен в таблице Параметры операции.
details	object Детали выполнения операции. Полный список параметров приведен в таблице Детали выполнения операции.

Параметры операции ('parameters')

Параметр	Описание
`project_id`	string Идентификатор проекта, для которого вы хотите получить текущий статус.
`pool_id`	string Идентификатор пула, для которого вы хотите получить текущий статус.
`training_id`	string Идентификатор обучающего пула, для которого вы хотите получить текущий статус.
`open_pool`	boolean Только для заданий и страниц заданий. Нужно ли открыть пул сразу после создания заданий или страниц заданий, если он закрыт.
`allow_defaults`	boolean Только для заданий и страниц заданий. Настройки перекрытия: `true` — использовать перекрытие, установленное в настройках пула (в поле `defaults.default_overlap_for_new_tasks`). `false` — использовать перекрытие, установленное в параметрах задания или страницы заданий (в поле `overlap`).
`skip_invalid_items`	boolean Только для заданий и страниц заданий. Параметры валидации JSON-объектов: `true` — создавать задания, прошедшие валидацию. Пропускать остальные задания (в ответе будут перечислены ошибки). `false` — останавливать операцию и не создавать задания, если одна или больше заданий не прошли валидацию.

Детали выполнения операции ('details')

Параметр	Описание
`total_count`	integer Количество элементов в запросе.
`valid_count`	integer Количество элементов, прошедших валидацию.
`not_valid_count`	integer Количество элементов, не прошедших валидацию.
`success_count`	integer Количество успешно созданных или загруженных элементов.
`failed_count`	integer Количество элементов, которые не удалось создать или загрузить.

Подробного описания ошибок в ответе нет. Если произошла ошибка, запросите лог операции.

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

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

Получить лог операции