latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

telemetry-controller

Save device attributes (saveDeviceAttributes)

Creates or updates the device attributes based on device id and specified attribute scope. The request payload is a JSON object with key-value format of attributes to create or update. For example:

{
 "stringKey":"value1", 
 "booleanKey":true, 
 "doubleKey":42.0, 
 "longKey":73, 
 "jsonKey": {
    "someNumber": 42,
    "someArray": [1,2,3],
    "someNestedObject": {"key": "value"}
 }
}

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

post/api/plugins/telemetry/{deviceId}/{scope}

Path parameters

deviceIdstring required

A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

scope'SERVER_SCOPE' | 'SHARED_SCOPE' required

A string value representing the attributes scope. For example, 'SERVER_SCOPE'.

Request body

string required

Response

Attribute from the request was created or updated. Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED', and also sends event msg to the rule engine with msg type 'ATTRIBUTES_UPDATED'.

string required