Отримати шаблон пристрою

GET 
/devices/:id/template

Шаблон пристрою

Request

Path Parameters

id integerrequired

Ідентифікатор пристрою

Responses

200

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

associations

object[]

Список асоціаційних груп

Array [

namestring

Назва групи асоціації

Example: Lifeline

groupdIdinteger

Ідентифікатор групи асоціації

Example: 1

lifelineboolean

Група - це життєва лінія груп (пристрої у цій групі отримуватимуть оновлення стану).

Example: true

maxDevicesinteger

Максимальна кількість пристроїв у групі

setEndpointboolean

Пристрої в цій групі будуть налаштовані як пристрої з кількома каналами.

devicesinteger[]

Пристрої додані до групи асоціації.

]

configuration

object[]

Список конфігураційних параметрів

Array [

oneOf

DeviceTemplateRangeParameter

namestring

Ім'я параметра

Example: Опис зміни поведінки

descriptionstring

Опис параметру

Example: Цей параметр контролює поведінку пристрою в певному випадку та в іншому випадку.

numberinteger

Номер параметру

Example: 1

signedboolean

Параметр підписаний (може мати від'ємні значення)

Example: false

sizeinteger

Розмір параметра в байтах

Possible values: [1, 2, 4]

Example: 2

valueinteger

Поточне значення параметра

Example: 2

typestringrequired

Тип параметру

Possible values: [range, variant, trigger]

properties

object

minimuminteger

Мінімальне значення параметра

maximuminteger

Максимальне значення параметра

DeviceTemplateVariantParameter

namestring

Ім'я параметра

Example: Опис зміни поведінки

descriptionstring

Опис параметру

Example: Цей параметр контролює поведінку пристрою в певному випадку та в іншому випадку.

numberinteger

Номер параметру

Example: 1

signedboolean

Параметр підписаний (може мати від'ємні значення)

Example: false

sizeinteger

Розмір параметра в байтах

Possible values: [1, 2, 4]

Example: 2

valueinteger

Поточне значення параметра

Example: 2

typestringrequired

Тип параметру

Possible values: [range, variant, trigger]

properties

object

variants

object[]

Список доступних варіантів параметрів

Array [

namestring

Варіант імені

valueinteger

Змінна значення

]

DeviceTemplateTriggerParameter

namestring

Ім'я параметра

Example: Опис зміни поведінки

descriptionstring

Опис параметру

Example: Цей параметр контролює поведінку пристрою в певному випадку та в іншому випадку.

numberinteger

Номер параметру

Example: 1

signedboolean

Параметр підписаний (може мати від'ємні значення)

Example: false

sizeinteger

Розмір параметра в байтах

Possible values: [1, 2, 4]

Example: 2

valueinteger

Поточне значення параметра

Example: 2

typestringrequired

Тип параметру

Possible values: [range, variant, trigger]

]

groupsobject

Example (from schema)

{
  "success": true,
  "associations": [
    {
      "name": "Lifeline",
      "groupdId": 1,
      "lifeline": true,
      "maxDevices": 0,
      "setEndpoint": true,
      "devices": [
        0
      ]
    }
  ],
  "configuration": [
    {
      "name": "Опис зміни поведінки",
      "description": "Цей параметр контролює поведінку пристрою в певному випадку та в іншому випадку.",
      "number": 1,
      "signed": false,
      "size": 2,
      "value": 2,
      "type": "range",
      "properties": {
        "minimum": 0,
        "maximum": 0
      }
    },
    {
      "name": "Опис зміни поведінки",
      "description": "Цей параметр контролює поведінку пристрою в певному випадку та в іншому випадку.",
      "number": 1,
      "signed": false,
      "size": 2,
      "value": 2,
      "type": "range",
      "properties": {
        "variants": [
          {
            "name": "string",
            "value": 0
          }
        ]
      }
    },
    {
      "name": "Опис зміни поведінки",
      "description": "Цей параметр контролює поведінку пристрою в певному випадку та в іншому випадку.",
      "number": 1,
      "signed": false,
      "size": 2,
      "value": 2,
      "type": "range"
    }
  ],
  "groups": {}
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}

403

Відмовлено в доступі

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4132,
  "errorMessage": "Access denied",
  "errorParameters": "Access denied"
}

404

Потрібний пристрій не знайдено.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4128,
  "errorMessage": "Not found",
  "errorParameters": {
    "type": "device",
    "id": 11
  }
}