POST
https://<server_address>/api/tasks
Данный метод позволяет создать новую задачу.
Запрос
Тело запроса
| Имя полей | Тип данных | Описание | Обязательный |
|---|---|---|---|
| name | string | Название задачи | Да |
| factoryNumbers | int[] | Список заводских номеров приборов, на которых должна распространяться данная задача | Да |
| isEnabled | bool | Флаг активации задачи | Да |
| typeId | guid | Идентификатор типа задачи. Он определяет шаблон задачи. Получить идентификаторы можно с помощью запросов на сервер | Да |
| settings | string | Json строка с заполненными параметрами задачи | Да |
Пример формирования json строки параметров задачи
Запрос схемы параметров вернул описание задачи:
Ответ на запрос схемы задачи
"data": {
"name": "FooTaskName",
"isDetected": true,
"settings": {
"Properties": {
"FooProperty": {
"Type": "string",
"Value": "value2",
"DisplayName": "Название параметра",
"AvailableValues": [
"value1",
"value2",
"value3"
]
},
"DevicePassword": {
"Type": "password",
"Value": 0,
"DisplayName": "Пароль прибора"
}
}
},
"id": "c9164690-b684-4bb2-9720-e8cfe2ab73c0"
},
Строка settings для отправки запроса на создание задачи будет следующей:
"{ \"FooProperty\" : \"value1\", \"DevicePassword\" : 123456 }"
Ответы сервера
Данный код возвращается в том случае, если создание прошло успешно.
Пример ответа
"data": {
"name": "FooTask",
"isDetected": true,
"settings": "string",
"id": "c9164690-b684-4bb2-9720-e8cfe2ab73c0"
},
Описание полей
| Имя поля | Тип данных | Описание | Обязательный |
|---|---|---|---|
| id | guid | Идентификатор созданной задачи | Да |
| name | string | Название задачи | Да |
| factoryNumbers | int[] | Список заводских номеров приборов, на которых должна распространяться данная задача. Задача будет распространяться на все приборы, если не передавать данный параметр | Нет |
| typeId | guid | Идентификатор типа задачи. Он определяет шаблон задачи. Получить идентификаторы можно с помощью запросов на сервер | Да |
| settings | string | Json строка с заполненными параметрами задачи | Да |
Данный код возвращается в том случае, если клиент не авторизован.