Skip to main content

PATCH - Частичное обновление задачи

Описание​

Метод PATCH /task-executions/{id} позволяет частично обновить выполнение задачи по её ID. Это полезно для изменения отдельных полей, таких как время начала и окончания, без необходимости полного обновления объекта выполнения задачи.

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

Для использования этого метода требуется токен доступа для аутентификации. Токен должен быть включен в заголовок запроса.

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

Authorization: Bearer {your_access_token}

Тело запроса​

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

{
  "startAt": "2023-03-06T18:00:00.000Z",
  "endAt": "2023-03-06T21:00:00.000Z"
}

Основные поля:​

  • startAt: Новое время начала задачи в формате ISO 8601.
  • endAt: Новое время окончания задачи в формате ISO 8601.

Другие поля, поддерживающие частичное обновление, могут быть включены по мере необходимости.

Ответ​

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

{
  "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,
  "priority": "NORMAL",
  "seriesId": "c0211758-6c24-4fd5-b932-7a0afc7c08a4",
  "assigned": true,
  "deadlined": false,
  "published": true,
  "edited": false,
  "stepCount": 10,
  "executedStepCount": 3
}

Ошибки​

Неверные данные ввода​

  • Код: 400 Bad Request
  • Пример ответа: 
    {
      "message": "invalid input data",
      "code": "input.data.invalid",
      "timestamp": "2023-03-06T18:38:28.788Z",
      "details": [
        {
          "message": "multiple resources not allowed",
          "code": "multiple.resources.not.allowed"
        }
      ]
    }
  • Описание: Предоставленные данные содержат недопустимые значения или конфликты, например, попытка обновить несколько ресурсов.

Несоответствие типа контента​

  • Код: 406 Not Acceptable
  • Пример ответа: 
    {
      "message": "mismatch in the types of content",
      "code": "not.acceptable",
      "timestamp": "2023-03-07T05:57:59.315Z"
    }
  • Описание: Тип контента запроса не соответствует ожидаемому типу контента сервера.

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

  • Код: 500 Internal Server Error
  • Пример ответа: 
    {
      "message": "internal server error",
      "code": "internal.server.error",
      "timestamp": "2023-03-07T05:57:59.315Z"
    }
  • Описание: Произошла неожиданная ошибка на сервере. Повторите запрос или обратитесь в службу поддержки, если ошибка не исчезает.

Заключение​

Метод PATCH /task-executions/{id} позволяет обновлять отдельные поля выполнения задачи без воздействия на другие данные. Он поддерживает частичное обновление полей, таких как startAt и endAt. Будьте внимательны к возможным ошибкам, таким как неверные данные ввода, несоответствие типа контента или проблемы на сервере.