- tocdepth
2
Просмотр истории задач
В этом разделе описан набор методов для просмотра истории задач.
- GET /v2/tasks
Получение списка задач.
- Query Parameters
productInstanceId (string) – [Deprecated] Идентификатор услуги.
limit (integer) – Количество задач в ответе.
offset (integer) – Количество пропущенных задач.
sort (string) – Параметры сортировки списка задач в виде «field direction». Возможные значения для field: updatedAt, createdAt. Возможные значения для direction: asc, desc.
filters (array) – Параметры фильтрации списка задач в виде «field condition value» или «field:value»(include). Возможные значения для field: action, objectType, status. Возможные значения для condition: =.
projectId (string) – Идентификатор проекта.
- Status Codes
200 OK – A successful response.
- Response JSON Object
items (array) – Список задач.
items[].createdAt (string) – Время создания задачи.
items[].data (object) – Данные, если задача завершилась успешно.
items[].data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
items[].error (object) – Ошибка, если задача завершилась с ошибкой.
items[].error.code (integer) – Код состояния.
items[].error.details (array) – Список сообщений, содержащих сведения об ошибке.
items[].error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
items[].error.message (string) – Сообщение об ошибке.
items[].eventName (string) – Тип события.
items[].id (string) – Идентификатор задачи.
items[].metadata (object) – Данные, если задача завершилась успешно.
items[].metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
items[].status (string) – Статус задачи.
items[].taskObjectId (string) – Идентификатор объекта задачи.
items[].taskObjectType (string) – Тип объекта задачи.
items[].updatedAt (string) – Время последнего обновления задачи.
items[].userId (string) – Идентификатор пользователя.
limit (integer) – Количество задач в ответе.
offset (integer) – Количество пропущенных задач.
total (integer) – Общее число задач.
- GET /v2/tasks/{taskId}
Получение задачи.
- Parameters
taskId (string) – Идентификатор задачи.
- Query Parameters
projectId (string) – Идентификатор проекта.
- Status Codes
200 OK – A successful response.
- Response JSON Object
task (object) – Информация о задаче.
task.createdAt (string) – Время создания задачи.
task.data (object) – Данные, если задача завершилась успешно.
task.data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error (object) – Ошибка, если задача завершилась с ошибкой.
task.error.code (integer) – Код состояния.
task.error.details (array) – Список сообщений, содержащих сведения об ошибке.
task.error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error.message (string) – Сообщение об ошибке.
task.eventName (string) – Тип события.
task.id (string) – Идентификатор задачи.
task.metadata (object) – Данные, если задача завершилась успешно.
task.metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.status (string) – Статус задачи.
task.taskObjectId (string) – Идентификатор объекта задачи.
task.taskObjectType (string) – Тип объекта задачи.
task.updatedAt (string) – Время последнего обновления задачи.
task.userId (string) – Идентификатор пользователя.
Была ли статья полезной?
для Dev & Test