Skip to main content

GET - Детали задачи по ID

Описание​

Метод GET /task-executions/{id} используется для получения подробной информации о выполнении конкретной задачи по её уникальному идентификатору. Он возвращает данные, такие как статус задачи, назначенный исполнитель, время выполнения, этапы, действия, а также ошибки или предупреждения, которые были встречены.

Авторизация​

Этот метод требует авторизации. Включите действующий токен доступа в заголовок запроса.

Пример заголовка авторизации:​

Authorization: Bearer {your_access_token}

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

URL:​

GET https://api.example.com/v1/task-executions/42f17f21-3ca4-4026-b578-4db633486a75

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

Код ответа:​

200 OK

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

{
  "id": "42f17f21-3ca4-4026-b578-4db633486a75",
  "scheduledTaskId": "242dcdf8-4de9-4d5a-9edf-596ca26c7a33",
  "name": "task 1",
  "description": null,
  "locationId": "9ee9b6c4-9124-48a7-93ef-739f94d49b9a",
  "performerId": "ce2300e2-2515-41ec-862b-e96b6c6e2756",
  "status": "ERROR",
  "state": "IN_PROGRESS",
  "published": false,
  "startAt": "2023-03-07T05:57:59.315Z",
  "endAt": "2023-03-07T05:57:59.315Z",
  "steps": [
    {
      "id": "7ab2df67-d552-4c3a-b0fd-6057c9481caf",
      "name": "name1",
      "order": 0,
      "actualOrder": 1,
      "status": "SUCCESS",
      "state": "COMPLETED",
      "actions": [
        {
          "id": "875c1068-e1ac-4b45-a520-6006a19e7fb5",
          "name": "action 1",
          "type": "NUMBER",
          "status": "ERROR",
          "state": "COMPLETED",
          "numberValue": 11,
          "minValue": 1,
          "maxValue": 22
        }
      ]
    }
  ]
}

Возможные ошибки​

400 Некорректные входные данные​

Код ответа:​

400 Bad Request

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

{
  "message": "invalid data type",
  "code": "data.type.invalid",
  "identifier": "id",
  "args": [
    "[UUID]"
  ]
}

Описание:​

Запрос содержит неверный идентификатор задачи или некорректно отформатированные данные.

404 Ресурс не найден​

Код ответа:​

404 Not Found

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

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Описание:​

Указанный идентификатор выполнения задачи не существует в системе.

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

Код ответа:​

500 Internal Server Error

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

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

Описание:​

Произошла неожиданная ошибка на сервере. Повторите запрос позже или обратитесь в службу поддержки.

Заключение​

Метод GET /task-executions/{id} является мощным инструментом для получения подробной информации о выполнении задачи. Он предоставляет информацию о статусе задачи, этапах, действиях и связанных с ними ошибках. Убедитесь, что у вас есть правильная авторизация и действующий идентификатор задачи при обращении к этому методу.