Skip to main content

PUT - Обновить детали задачи

Описание​

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

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

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

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

Authorization: Bearer {your_access_token}

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

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

{
  "assigneeIds": [
    "4f9e4741-3069-4a03-8386-5f3ee45791aa"
  ],
  "locationId": "03864752-f177-47ff-b0a1-99d75b02d954",
  "name": "task 1",
  "description": null,
  "startAt": "2023-03-06T18:00:00.000Z",
  "endAt": "2023-03-06T21:00:00.000Z",
  "priority": "MAJOR",
  "orderStepsRequired": true,
  "strictTimeRequired": false,
  "deadlined": false,
  "tags": [
    "task 1"
  ],
  "steps": [
    {
      "id": "61aac9c7-e128-428c-a9b5-40d9593013ec",
      "pointId": "9facfd8e-1fe3-4449-80be-1003bcf238a2",
      "name": "step 1",
      "order": 0,
      "actions": [
        {
          "id": "ff56c5d4-8932-44f0-9d7c-50ff66ab9cb5",
          "name": "action 1",
          "type": "BOOLEAN",
          "order": 0,
          "required": false
        },
        {
          "id": null,
          "name": "action 2",
          "type": "TEXT",
          "order": 1,
          "required": true
        }
      ]
    }
  ]
}

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

  • assigneeIds: Список ID пользователей, назначенных на задачу.
  • locationId: ID местоположения, где будет выполнена задача.
  • name: Название задачи.
  • description: Необязательное описание задачи.
  • startAt / endAt: Время начала и окончания задачи в формате ISO 8601.
  • priority: Приоритет задачи (например, "MAJOR", "NORMAL").
  • steps: Детали шагов, которые включены в выполнение задачи, включая действия.

Ответ​

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

{
  "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",
  "totalExecutedTimeInMillis": 18000000,
  "priority": "NORMAL",
  "stepCount": 10,
  "executedStepCount": 3
}

Ошибки​

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

  • Код: 400 Bad Request
  • Пример ответа: 
    {
      "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"
    }
  • Описание: Произошла непредвиденная ошибка на сервере. Повторите запрос позже или свяжитесь с поддержкой.

Заключение​

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