Skip to main content

PUT - Обновить серию задач

Описание​

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

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

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

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

Authorization: Bearer {your_access_token}

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

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

{
  "seriesId": "475c2d64-b564-4f17-9833-ac3793ee43b4",
  "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": [
    {
      "seriesId": "a5f2b3e4-3e38-4a37-9177-a6340b291bf0",
      "pointId": "9facfd8e-1fe3-4449-80be-1003bcf238a2",
      "name": "step 1",
      "order": 0,
      "actions": [
        {
          "seriesId": "f359914d-20d2-4bfc-9a3f-87cec4f5ebe0",
          "name": "action 1",
          "type": "BOOLEAN",
          "order": 0,
          "required": false
        },
        {
          "seriesId": "198d2b6a-3974-48d7-bc0e-f0a88b49e10c",
          "name": "action 2",
          "type": "TEXT",
          "order": 1,
          "required": true
        }
      ]
    }
  ]
}

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

  • seriesId: ID обновляемой серии задач.
  • assigneeIds: Список ID пользователей, назначенных на задачу.
  • locationId: ID местоположения, связанного с задачей.
  • name: Название серии задач.
  • description: Описание задачи (может быть null).
  • startAt: Время начала задачи в формате ISO 8601.
  • endAt: Время окончания задачи в формате ISO 8601.
  • priority: Приоритет задачи (например, "MAJOR", "NORMAL").
  • orderStepsRequired: Булево значение, указывающее, нужно ли выполнять шаги в порядке.
  • strictTimeRequired: Булево значение, указывающее, требуется ли строгое соблюдение времени.
  • deadlined: Булево значение, указывающее, есть ли у задачи срок.
  • tags: Массив тегов, связанных с задачей.
  • steps: Массив объектов шагов, каждый из которых содержит:
    • seriesId: ID серии шага.
    • pointId: ID точки, связанной с шагом.
    • name: Название шага.
    • order: Порядок шага в последовательности.
    • actions: Массив действий для шага, каждое из которых имеет поля:
      • seriesId: ID серии действия.
      • name: Название действия.
      • type: Тип действия (например, "BOOLEAN", "TEXT").
      • order: Порядок действия.
      • required: Булево значение, указывающее, является ли действие обязательным.

Ответ​

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

{
  "updatingSeriesId": "475c2d64-b564-4f17-9833-ac3793ee43b4",
  "createdSeriesId": "d6f4c4ff-f402-45b2-b7d7-b009fd16e44d"
}

Ошибки​

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

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

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

  • Код: 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}/series позволяет обновлять серию задач, включая ее данные, шаги, действия и назначения. Он поддерживает гибкую настройку, но требует правильно структурированных данных. Ошибки могут возникать из-за неверных данных, несоответствия типов контента или проблем на сервере.