3. Создание устройства с токеном

Устройство − датчик, подключаемый по IoT-сети. Например, счетчик утечки газа, учета водоснабжения или измерения микроклимата помещения.

Устройство создается только после успешного добавления класса, наличие клиента в системе необязательно.
Количество создаваемых устройств неограниченно.

Токен — уникальное значение, идентифицирующее устройство в платформе.

При выполнении запроса на добавление устройства укажите атрибут, добавленный при создании класса устройства, необходимый для идентификации устройства — в примере тела запроса ниже для этой цели указан атрибут “token”.
Значение данного атрибута должно быть уникально и может соответствовать как заводскому неизменяемому значению, так и сгенерированному вручную значению для платформы.

Для создания нового устройства используйте метод POST /front-api-srv/api/v1.1/device. В теле запроса метода укажите значения параметров, которые необходимы для создания устройства в системе.

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	-	Наименование устройства	УСПД 1
сlassId	body	string	+	Идентификатор класса устройства, созданного в ModelAPI	00d00000-0ed0-0a0f-beb0-df0b000a0000
clientId	body	string	-	Идентификатор клиента, которому принадлежит устройство	d00a0b00-0000-0000-af00-0caca0bc000d
properties	body	object	-	Свойства устройства	-

object “properties”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
attributes	body	array of objects	-	Массив атрибутов устройства	-

object “attribute”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
server	body	object	-	Массив свойств устройства, изменяемых только через интерфейс платформы	-
shared	body	object	-	Массив свойств, изменяемых и устройством, и клиентом	-
client	body	object	-	Массив свойств устройства, изменяемых только самим устройством	-

object “server”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
<property1_name>	body	<prop1_datatype>	-	<prop1_value>	“token”: “generatedToken-e53d7b39-11c8-4ae4-8363-474df9325262”
<property2_name>	body	<prop2_datatype>	-	<prop2_value>	-

Пример тела запроса:

1
{
2
    "name": "УСПД 1",
3
    "classId": "00d00000-0ed0-0a0f-beb0-df0b000a0000",
4
    "clientId": "d00a0b00-0000-0000-af00-0caca0bc000d",
5
    "properties": {
6
        "attributes": {
7
            "server": {
8
                "token": "generatedToken-e53d7b39-11c8-4ae4-8363-474df9325262"
9
            }
10
        }
11
    }
12
}

После успешного выполнения запроса будет получен ответ, который содержит сохраненные данные устройства, а также сформированный идентификатор устройства в системе deviceId. Значение данного параметра необходимо для прохождения следующих шагов процесса.

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

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

1
{
2
    "id": "000000b0-00ca-0000-00f0-0a0000000eb0",
3
    "name": "УСПД 1",
4
    "classId": "00d00000-0ed0-0a0f-beb0-df0b000a0000",
5
    "clientId": "d00a0b00-0000-0000-af00-0caca0bc000d",
6
    "tenantId": "00f00a00-e00f-0a00-af0a-c0af00e0ff00",
7
    "assets": [],
8
    "properties": {
9
        "attributes": {
10
            "server": {
11
                "token": "generatedToken-e53d7b39-11c8-4ae4-8363-474df9325262"
12
            }
13
        },
14
        "telemetry": {}
15
    },
16
    "createdWhen": "2023-03-02T09:15:37.721997083Z",
17
    "updatedWhen": "2023-03-02T09:15:37.721997083Z"
18
}