Перейти к содержимому

5. Получение данных от устройства

Получить данные по устройству можно после его регистрации в системе.

Если устройство подключено и настроено на передачу данных, то полученные данные от устройства можно запросить с помощью метода GET /front-api-srv/api/v1.1/device/<deviceId>, где вместо <deviceId> указать идентификатор устройства, полученный на шаге Создание устройства с токеном текущего процесса.

ПараметрТипТип данныхОбяз.ОписаниеПример
deviceIdurlstring+Идентификатор устройства000000b0-00ca-0000-00f0-0a0000000eb0

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

ПараметрТип данныхОписаниеПример
idstringИдентификатор устройства на платформе000000b0-00ca-0000-00f0-0a0000000eb0
namestringНаименование устройстваУСПД 1
сlassIdstringИдентификатор класса устройства, созданного в ModelAPI00d00000-0ed0-0a0f-beb0-df0b000a0000
clientIdstringИдентификатор клиента, которому принадлежит устройствоd00a0b00-0000-0000-af00-0caca0bc000d
tenantIdstringИдентификатор продукта на платформе00f00a00-e00f-0a00-af0a-c0af00e0ff00
assetsarray of stringМассив идентификаторов объектов, к которым должно быть привязано устройство-
propertiesobjectСвойства устройства-
createdWhentimestampДата и время создания записи на платформе2023-03-02T09:25:53.381410Z
updatedWhentimestampДата и время последнего обновления записи2023-03-02T09:25:53.381410Z

object “properties”

ПараметрТип данныхОписаниеПример
attributesarray of objectsМассив атрибутов устройства-
telemetryarray of objectsМассив телеметрии устройства-

object “attributes”

ПараметрТип данныхОписаниеПример
serverobjectМассив свойств устройства, изменяемых только через интерфейс платформы-

object “server”,“shared”, “client”, “telemetry”

ПараметрТип данныхОписаниеПример
<property1_name><property1_datatype><property1_value>token
<property2_name><property2_datatype><property2_value>rssi / temp

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

shell
curl --location -g --request GET 'api/v1.1/device/000000b0-00ca-0000-00f0-0a0000000eb0' \
--header 'X-Tenant-API-Key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.6POk6yJV_adQssw5c' \

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

json
{
    "id": "000000b0-00ca-0000-00f0-0a0000000eb0",
    "name": "УСПД 1",
    "classId": "00d00000-0ed0-0a0f-beb0-df0b000a0000",
    "clientId": "d00a0b00-0000-0000-af00-0caca0bc000d",
    "tenantId": "00f00a00-e00f-0a00-af0a-c0af00e0ff00",
    "assets": [],
    "properties": {
        "attributes": {
            "server": {
                "token": "generatedToken-e53d7b39-11c8-4ae4-8363-474df9325262"
            }
        },
        "telemetry": {
            "rssi": -79,
            "temp": 21
        }
    },
    "createdWhen": "2023-03-02T09:25:53.381410Z",
    "updatedWhen": "2023-03-02T09:25:53.381410Z"
}

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