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