Skip to main content

POST - Создать задачу на выполнение

Описание​

Метод POST /task-executions используется для создания задач с указанными параметрами, такими как назначенные исполнители, местоположение, описание, время выполнения, шаги и другие данные, связанные с задачей.

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

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

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

Authorization: Bearer {your_access_token}

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

{
  "assigneeIds": [
    "4f9e4741-3069-4a03-8386-5f3ee45791aa"
  ],
  "locationId": "03864752-f177-47ff-b0a1-99d75b02d954",
  "name": "task 1",
  "description": null,
  "recurrence": {
    "rule": "FREQ=DAILY;UNTIL=20230309T210000Z",
    "exception": "20230307T210000Z,20230309T210000Z"
  },
  "startAt": "2023-03-06T18:00:00.000Z",
  "endAt": "2023-03-06T21:00:00.000Z",
  "priority": "NORMAL",
  "orderStepsRequired": true,
  "strictTimeRequired": false,
  "deadlined": false,
  "tags": [
    "task 1"
  ],
  "steps": [
    {
      "pointId": "9facfd8e-1fe3-4449-80be-1003bcf238a2",
      "name": "step 1",
      "order": 0,
      "actions": [
        {
          "name": "action 1",
          "type": "BOOLEAN",
          "order": 0,
          "required": false
        },
        {
          "name": "action 2",
          "type": "NUMBER",
          "order": 1,
          "required": true,
          "minValue": 11.1,
          "maxValue": 12.1
        }
      ]
    }
  ]
}

Успешный ответ​

Код ответа:​

200 OK

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

[
  {
    "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
  }
]

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

401 Неавторизованный​

Код ответа:​

401 Unauthorized

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

{
  "message": "unauthorized access",
  "code": "unauthorized"
}

Описание:​

Запрос был выполнен без токена или с недействительным токеном.

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

Код ответа:​

400 Bad Request

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

{
  "message": "multiple resources not allowed",
  "code": "multiple.resources.not.allowed"
}

Описание:​

Запрос содержит неверные данные, например, указаны несколько ресурсов, когда разрешен только один.

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

Код ответа:​

500 Internal Server Error

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

{
  "message": "internal server error",
  "code": "internal.server.error"
}

Описание:​

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

Итог​

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