GET - Список задач

Описание

Метод GET /task-executions/info используется для получения подробной информации о задачах. Он поддерживает фильтрацию, сортировку и пагинацию, чтобы настроить ответ в соответствии с потребностями пользователя.

Параметры запроса

Параметр	Описание	Пример	По умолчанию
limit (целое число)	Максимальное количество элементов в результате.	`20`	`2147483647`
offset (целое число)	Количество элементов, которые нужно пропустить перед тем, как начать включать результаты.	`0`	`0`
sort (строка)	Сортировка результатов по полю и направлению (`asc` или `desc`).	`startAt,asc`
q (строка)	Быстрый поиск по текстовым полям.	`Task 1`
startAt (строка)	Фильтрация задач, начинающихся после определённой даты.	`gt:2023-03-07T00:00:00.000Z`
endAt (строка)	Фильтрация задач, заканчивающихся до определённой даты.	`lt:2023-03-10T00:00:00.000Z`
name (строка)	Фильтрация по названию задачи.	`Task 1`
priority (строка)	Фильтрация по приоритету (`NORMAL`, `MAJOR` и т. д.).	`in:NORMAL`
userId (строка)	Фильтрация по ID пользователей.	`in:817f6eca-6276-4993-bfeb-53cbbbba6f08`
state (строка)	Фильтрация по состоянию задачи (`IN_PROGRESS`, `COMPLETED`).	`in:IN_PROGRESS`
locationId (строка)	Фильтрация по ID локаций.	`in:638b90c5-7965-49ae-a02b-1b190cb216db`
pointId (строка)	Фильтрация по ID точек.	`in:497f6eca-6276-4993-bfeb-53cbbbba6f08`
withDateIntersection (логическое значение)	Включить задачи, которые пересекаются с диапазоном дат.	`true`
includeOpenTasks (логическое значение)	Включить задачи, которые ещё не завершены.	`true`
tags (строка)	Фильтрация по тегам.	`in:tag1,tag2`
status (строка)	Фильтрация по статусу задачи (`SUCCESS`, `ERROR` и т. д.).	`in:SUCCESS,WARNING,ERROR`
published (логическое значение)	Фильтрация по тому, опубликована ли задача.	`true`

Пример запроса

GET /task-executions/info?limit=20&offset=0&sort=startAt,asc&name=Task%201&state=in:IN_PROGRESS
Authorization: Bearer {your_access_token}

Пример успешного ответа

Тело ответа:

{
  "data": [
    {
      "id": "e30fc67c-f946-414a-b4f9-423eabb90534",
      "scheduledTaskId": "d6f4c4ff-f402-45b2-b7d7-b009fd16e44d",
      "performerId": "8fa4464d-5c26-49a2-934c-84226ec83caa",
      "assigneeIds": [
        "3467d855-5478-41a9-b192-5e41b9cbd87d",
        "f3e03f65-d557-405d-ac89-a4d3054b8578"
      ],
      "name": "Task 1",
      "state": "IN_PROGRESS",
      "status": "SUCCESS",
      "startAt": "2023-03-07T05:00:00.000Z",
      "endAt": "2023-03-07T10:00:00.000Z",
      "startedAt": "2023-03-07T05:00:00.000Z",
      "endedAt": "2023-03-07T10:00:00.000Z",
      "totalExecutedTimeInMillis": 18000000,
      "errorCount": 0,
      "warningCount": 0,
      "priority": "NORMAL",
      "seriesId": "c0211758-6c24-4fd5-b932-7a0afc7c08a4",
      "assigned": true,
      "deadlined": false,
      "published": true,
      "edited": false,
      "stepCount": 10,
      "executedStepCount": 3
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 1,
    "count": 1000,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ]
  },
  "filter": [
    {
      "property": "name",
      "value": "Task 1"
    }
  ]
}

Ошибки

Внутренняя ошибка сервера

Код: 500 Internal Server Error

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

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Описание: Произошла неожиданная ошибка на сервере.

Заключение

Метод GET /task-executions/info позволяет выполнять детализированные и настраиваемые запросы для задач. Он поддерживает расширенные возможности фильтрации, сортировки и пагинации. Несмотря на наличие множества настроек, возможные ошибки могут быть связаны с проблемами на сервере (например, внутренняя ошибка сервера).

Описание​

Параметры запроса​

Пример запроса​

Пример успешного ответа​

Тело ответа:​

Ошибки​

Внутренняя ошибка сервера​

Заключение​