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

В результате некоторых запросов к API (открытие и закрытие пула, отправка пула или проекта в архив, загрузка страниц заданий, выдача бонусов) создается асинхронная операция, выполняемая в фоновом режиме. Сведения об операции (например, статус, время создания) передаются в формате JSON.

Пример JSON с данными операции и описание ключей представлены ниже.

Вы можете отслеживать выполнение операций с помощью API:

Пример операции в JSON

{
  "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" : fase,
    "allow_defaults" : false,
    "skip_invalid_items" : false
  }
  "details" : {
    "total_count" : 2,
    "valid_count" : 0,
    "failed_count" : 2,
    "success_count" : 0,
    "not_valid_count" : 2
  }
}
Скопировано

Ключи

Ключ

Значение

Тип данных

Обязателен

id

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

Строка

Да

type

Тип операции:

  • POOL.OPEN — открытие пула.

  • POOL.CLOSE — закрытие пула.

  • PROJECT.ARCHIVE — отправка проекта в архив.

  • POOL.ARCHIVE — отправка пула в архив.

  • SOLUTION.AGGREGATE — агрегация ответов.
  • TASK_SUITE.BATCH_CREATE — создание нескольких страниц заданий.

Строка

Да

status

Статус операции:

  • PENDING — выполнение не началось.

  • RUNNING — выполняется.

  • SUCCESS — успешно выполнена.

  • FAIL — не выполнена.

Строка

Да

submitted

Дата и время отправки запроса по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Строка

Да

started

Дата и время начала операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Строка

Нет

finished

Дата и время завершения операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Строка

Нет

progress

Ход выполнения операции в процентах.

Число

Нет

parameters

Параметры операции (зависят от типа операции).

JSON

Нет

details

Детали выполнения операции.

JSON

Нет

Ключ

Значение

Тип данных

Обязателен

id

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

Строка

Да

type

Тип операции:

  • POOL.OPEN — открытие пула.

  • POOL.CLOSE — закрытие пула.

  • PROJECT.ARCHIVE — отправка проекта в архив.

  • POOL.ARCHIVE — отправка пула в архив.

  • SOLUTION.AGGREGATE — агрегация ответов.
  • TASK_SUITE.BATCH_CREATE — создание нескольких страниц заданий.

Строка

Да

status

Статус операции:

  • PENDING — выполнение не началось.

  • RUNNING — выполняется.

  • SUCCESS — успешно выполнена.

  • FAIL — не выполнена.

Строка

Да

submitted

Дата и время отправки запроса по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Строка

Да

started

Дата и время начала операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Строка

Нет

finished

Дата и время завершения операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Строка

Нет

progress

Ход выполнения операции в процентах.

Число

Нет

parameters

Параметры операции (зависят от типа операции).

JSON

Нет

details

Детали выполнения операции.

JSON

Нет