node-red-contrib-thingsboard-pe-rest-api v3.3.3
node-red-contrib-thingsboard-pe-rest-api
Node-RED node for thingsboard-pe-rest-api
ThingsBoard Professional Edition IoT platform REST API documentation.
Install
To install the stable version use the Menu - Manage palette - Install
option and search for node-red-contrib-thingsboard-pe-rest-api, or run the following
command in your Node-RED user directory, typically ~/.node-red
npm install node-red-contrib-thingsboard-pe-rest-apiUsage
Methods
GET /api/admin/securitySettings
Get the Security Settings object that contains password policy, etc.
Available for users with 'SYS_ADMIN' authority.
Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource.
Accept : 'application/json'POST /api/admin/securitySettings
Updates the Security Settings object that contains password policy, etc.
Available for users with 'SYS_ADMIN' authority.
Security check is performed to verify that the user has 'WRITE' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/admin/settings
Creates or Updates the Administration Settings. Platform generates random Administration Settings Id during settings creation. The Administration Settings Id will be present in the response. Specify the Administration Settings Id when you would like to update the Administration Settings. Referencing non-existing Administration Settings Id will cause an error.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
Security check is performed to verify that the user has 'WRITE' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/admin/settings/testMail
Attempts to send test email using Mail Settings provided as a parameter. Email is sent to the address specified in the profile of user who is performing the requestYou may change the 'To' email in the user profile of the System/Tenant Administrator.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/admin/settings/testSms
Attempts to send test sms to the System Administrator User using SMS Settings and phone number provided as a parameters of the request.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/admin/settings/{key}{?systemByDefault}
Get the Administration Settings object using specified string key. Referencing non-existing key will cause an error.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource.
key : string
systemByDefault : boolean
Accept : 'application/json'GET /api/admin/updates
Check notifications about new platform releases.
Available for users with 'SYS_ADMIN' authority.
Accept : 'application/json'POST /api/auth/login
Login method used to authenticate user and get JWT token data.
Value of the response token field can be used as X-Authorization header value:
X-Authorization: Bearer $JWT_TOKEN_VALUE.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/alarm
Creates or Updates the Alarm. When creating alarm, platform generates Alarm Id as time-based UUID. The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. Referencing non-existing Alarm Id will cause 'Not Found' error.
Platform also deduplicate the alarms based on the entity id of originator and alarm 'type'. For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/alarm/highestSeverity/{entityType}/{entityId}{?searchStatus,status}
Search the alarms by originator ('entityType' and entityId') and optional 'status' or 'searchStatus' filters and returns the highest AlarmSeverity(CRITICAL, MAJOR, MINOR, WARNING or INDETERMINATE). Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
entityType : string
entityId : string
searchStatus : string
status : string
Accept : 'application/json'GET /api/alarm/info/{alarmId}
Fetch the Alarm Info object based on the provided Alarm Id. Alarm Info is an extension of the default Alarm object that also contains name of the alarm originator.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
alarmId : string
Accept : 'application/json'GET /api/alarm/{alarmId}
Fetch the Alarm object based on the provided Alarm Id.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
alarmId : string
Accept : 'application/json'DELETE /api/alarm/{alarmId}
Deletes the Alarm. Referencing non-existing Alarm Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for the entity (entities).
alarmId : string
Accept : 'application/json'POST /api/alarm/{alarmId}/ack
Acknowledge the Alarm. Once acknowledged, the 'ack_ts' field will be set to current timestamp and special rule chain event 'ALARM_ACK' will be generated. Referencing non-existing Alarm Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
alarmId : string
Accept : 'application/json'POST /api/alarm/{alarmId}/clear
Clear the Alarm. Once cleared, the 'clear_ts' field will be set to current timestamp and special rule chain event 'ALARM_CLEAR' will be generated. Referencing non-existing Alarm Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
alarmId : string
Accept : 'application/json'GET /api/alarm/{entityType}/{entityId}{?endTime,fetchOriginator,page,pageSize,searchStatus,sortOrder,sortProperty,startTime,status,textSearch}
Returns a page of alarms for the selected entity. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
entityType : string
entityId : string
searchStatus : string
status : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
fetchOriginator : boolean
Accept : 'application/json'GET /api/alarms{?endTime,fetchOriginator,page,pageSize,searchStatus,sortOrder,sortProperty,startTime,status,textSearch}
Returns a page of alarms that belongs to the current user owner. If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. If the user has the authority of 'Customer User', the server returns alarms that belongs to the customer of current user. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
searchStatus : string
status : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
fetchOriginator : boolean
Accept : 'application/json'POST /api/asset/bulk_import
There's an ability to import the bulk of assets using the only .csv file.
Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/asset/types
Returns a set of unique asset types based on assets that are either owned by the tenant or assigned to the customer which user is performing the request.
Accept : 'application/json'GET /api/asset/{assetId}
Fetch the Asset object based on the provided Asset Id. If the user has the authority of 'Tenant Administrator', the server checks that the asset is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the asset is assigned to the same customer.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
assetId : string
Accept : 'application/json'DELETE /api/asset/{assetId}
Deletes the asset and all the relations (from and to the asset). Referencing non-existing asset Id will cause an error.
Security check is performed to verify that the user has 'DELETE' permission for the entity (entities).
assetId : string
Accept : 'application/json'POST /api/assets
Returns all assets that are related to the specific entity. The entity id, relation type, asset types, depth of the search, and other query parameters defined using complex 'AssetSearchQuery' object. See 'Model' tab of the Parameters for more info.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/assets{?assetIds}
Requested assets must be owned by tenant or assigned to customer which user is performing the request.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
assetIds : string
Accept : 'application/json'POST /api/asset{?entityGroupId}
Creates or Updates the Asset. When creating asset, platform generates Asset Id as time-based UUID. The newly created Asset id will be present in the response. Specify existing Asset id to update the asset. Referencing non-existing Asset Id will cause 'Not Found' error.
Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
entityGroupId : string
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/customer/{customerId}/assets{?page,pageSize,sortOrder,sortProperty,textSearch,type}
Returns a page of assets objects owned by customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerId : string
pageSize : integer
page : integer
type : string
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/entityGroup/{entityGroupId}/assets{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of asset objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Security check is performed to verify that the user has 'READ' permission for specified group.
entityGroupId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/tenant/assets{?assetName}
Requested asset must be owned by tenant that the user belongs to. Asset name is an unique property of asset. So it can be used to identify the asset.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
assetName : string
Accept : 'application/json'GET /api/tenant/assets{?page,pageSize,sortOrder,sortProperty,textSearch,type}
Returns a page of assets owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
type : string
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/user/assets{?page,pageSize,sortOrder,sortProperty,textSearch,type}
Returns a page of assets objects available for the current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Asset Info is an extension of the default Asset object that contains information about the assigned customer name.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
type : string
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/audit/logs/customer/{customerId}{?actionTypes,endTime,page,pageSize,sortOrder,sortProperty,startTime,textSearch}
Returns a page of audit logs related to the targeted customer entities (devices, assets, etc.), and users actions (login, logout, etc.) that belong to this customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs.
customerId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
actionTypes : string
Accept : 'application/json'GET /api/audit/logs/entity/{entityType}/{entityId}{?actionTypes,endTime,page,pageSize,sortOrder,sortProperty,startTime,textSearch}
Returns a page of audit logs related to the actions on the targeted entity. Basically, this API call is used to get the full lifecycle of some specific entity. For example to see when a device was created, updated, assigned to some customer, or even deleted from the system. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs.
entityType : string
entityId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
actionTypes : string
Accept : 'application/json'GET /api/audit/logs/user/{userId}{?actionTypes,endTime,page,pageSize,sortOrder,sortProperty,startTime,textSearch}
Returns a page of audit logs related to the actions of targeted user. For example, RPC call to a particular device, or alarm acknowledgment for a specific device, etc. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs.
userId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
actionTypes : string
Accept : 'application/json'GET /api/audit/logs{?actionTypes,endTime,page,pageSize,sortOrder,sortProperty,startTime,textSearch}
Returns a page of audit logs related to all entities in the scope of the current user's Tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs.
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
actionTypes : string
Accept : 'application/json'POST /api/auth/changePassword
Change the password for the User which credentials are used to perform this REST API call. Be aware that previously generated JWT tokens will be still valid until they expire.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/auth/logout
Special API call to record the 'logout' of the user to the Audit Logs. Since platform uses JWT, the actual logout is the procedure of clearing the JWT token on the client side.
Accept : 'application/json'GET /api/auth/user
Get the information about the User which credentials are used to perform this REST API call.
Accept : 'application/json'GET /api/noauth/activate{?activateToken}
Checks the activation token and forwards user to 'Create Password' page. If token is valid, returns '303 See Other' (redirect) response code with the correct address of 'Create Password' page and same 'activateToken' specified in the URL parameters. If token is not valid, returns '409 Conflict'.
activateToken : string
Accept : 'application/json'POST /api/noauth/activate{?sendActivationMail}
Checks the activation token and updates corresponding user password in the database. Now the user may start using his password to login. The response already contains the JWT activation and refresh tokens, to simplify the user activation flow and avoid asking user to input password again after activation. If token is valid, returns the object that contains JWT access and refresh tokens. If token is not valid, returns '404 Bad Request'.
sendActivationMail : boolean
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/noauth/resetPassword
Checks the password reset token and updates the password. If token is valid, returns the object that contains JWT access and refresh tokens. If token is not valid, returns '404 Bad Request'.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/noauth/resetPasswordByEmail
Request to send the reset password email if the user with specified email address is present in the database. Always return '200 OK' status for security purposes.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/noauth/resetPassword{?resetToken}
Checks the password reset token and forwards user to 'Reset Password' page. If token is valid, returns '303 See Other' (redirect) response code with the correct address of 'Reset Password' page and same 'resetToken' specified in the URL parameters. If token is not valid, returns '409 Conflict'.
resetToken : string
Accept : 'application/json'GET /api/noauth/userPasswordPolicy
API call to get the password policy for the password validation form(s).
Accept : 'application/json'GET /api/blobEntities{?blobEntityIds}
Requested blob entities must be owned by tenant or assigned to customer which user is performing the request. The platform uses Blob(binary large object) entities in the reporting feature, in order to store Dashboard states snapshots of different content types in base64 format. BlobEntityInfo represents an object that contains base info about the blob entity(name, type, contentType, etc.). See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
blobEntityIds : string
Accept : 'application/json'GET /api/blobEntities{?endTime,page,pageSize,sortOrder,sortProperty,startTime,textSearch,type}
Returns a page of BlobEntityWithCustomerInfo object that are available for the current user. The platform uses Blob(binary large object) entities in the reporting feature, in order to store Dashboard states snapshots of different content types in base64 format. BlobEntityWithCustomerInfo represents an object that contains base info about the blob entity(name, type, contentType, etc.) and info about the customer(customerTitle, customerIsPublic) of the user that scheduled generation of the dashboard report. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
type : string
textSearch : string
sortProperty : string
sortOrder : string
startTime : integer
endTime : integer
Accept : 'application/json'GET /api/blobEntity/info/{blobEntityId}
Fetch the BlobEntityWithCustomerInfo object based on the provided Blob entity Id. The platform uses Blob(binary large object) entities in the reporting feature, in order to store Dashboard states snapshots of different content types in base64 format. BlobEntityWithCustomerInfo represents an object that contains base info about the blob entity(name, type, contentType, etc.) and info about the customer(customerTitle, customerIsPublic) of the user that scheduled generation of the dashboard report. Referencing non-existing Blob entity Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
blobEntityId : string
Accept : 'application/json'DELETE /api/blobEntity/{blobEntityId}
Delete Blob entity based on the provided Blob entity Id. Referencing non-existing Blob entity Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
Security check is performed to verify that the user has 'DELETE' permission for the entity (entities).
blobEntityId : string
Accept : 'application/json'GET /api/blobEntity/{blobEntityId}/download
Download report file based on the provided Blob entity Id. Referencing non-existing Blob entity Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
blobEntityId : string
Accept : 'application/json'GET /api/component/{componentDescriptorClazz}
Gets the Component Descriptor object using class name from the path parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
componentDescriptorClazz : string
Accept : 'application/json'GET /api/components/{componentType}{?ruleChainType}
Gets the Component Descriptors using rule node type and optional rule chain type request parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
componentType : string
ruleChainType : string
Accept : 'application/json'GET /api/components{?componentTypes,ruleChainType}
Gets the Component Descriptors using coma separated list of rule node types and optional rule chain type request parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database.
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
componentTypes : string
ruleChainType : string
Accept : 'application/json'POST /api/converter
Create or update the Converter. When creating converter, platform generates Converter Id as time-based UUID. The newly created converter id will be present in the response. Specify existing Converter id to update the converter. Referencing non-existing converter Id will cause 'Not Found' error. Converter name is unique in the scope of tenant.
Converter Configuration
Converter configuration ('configuration' field) is the JSON object that should contain one of two possible fields: 'decoder' or 'encoder'. The former is used when the converter has UPLINK type, the latter is used - when DOWNLINK type. It can contain both 'decoder' and 'encoder' fields, when the correct one is specified for the appropriate converter type, another one can be set to 'null'. See the examples of each one below.
Uplink Converter Configuration
{
"decoder":"// Decode an uplink message from a buffer\n// payload - array of bytes\n// metadata - key/value object\n\n/** Decoder **/\n\n// decode payload to string\nvar payloadStr = decodeToString(payload);\n\n// decode payload to JSON\n// var data = decodeToJson(payload);\n\nvar deviceName = 'Device A';\nvar deviceType = 'thermostat';\nvar customerName = 'customer';\nvar groupName = 'thermostat devices';\n// use assetName and assetType instead of deviceName and deviceType\n// to automatically create assets instead of devices.\n// var assetName = 'Asset A';\n// var assetType = 'building';\n\n// Result object with device/asset attributes/telemetry data\nvar result = {\n// Use deviceName and deviceType or assetName and assetType, but not both.\n deviceName: deviceName,\n deviceType: deviceType,\n// assetName: assetName,\n// assetType: assetType,\n customerName: customerName,\n groupName: groupName,\n attributes: {\n model: 'Model A',\n serialNumber: 'SN111',\n integrationName: metadata['integrationName']\n },\n telemetry: {\n temperature: 42,\n humidity: 80,\n rawData: payloadStr\n }\n};\n\n/** Helper functions **/\n\nfunction decodeToString(payload) {\n return String.fromCharCode.apply(String, payload);\n}\n\nfunction decodeToJson(payload) {\n // covert payload to string.\n var str = decodeToString(payload);\n\n // parse string to JSON\n var data = JSON.parse(str);\n return data;\n}\n\nreturn result;",
"encoder":null
}Decoder field in the more readable form:
// Decode an uplink message from a buffer
// payload - array of bytes
// metadata - key/value object
/** Decoder **/
// decode payload to string
var payloadStr = decodeToString(payload);
// decode payload to JSON
// var data = decodeToJson(payload);
var deviceName = 'Device A';
var deviceType = 'thermostat';
var customerName = 'customer';
var groupName = 'thermostat devices';
// use assetName and assetType instead of deviceName and deviceType
// to automatically create assets instead of devices.
// var assetName = 'Asset A';
// var assetType = 'building';
// Result object with device/asset attributes/telemetry data
var result = {
// Use deviceName and deviceType or assetName and assetType, but not both.
deviceName: deviceName,
deviceType: deviceType,
// assetName: assetName,
// assetType: assetType,
customerName: customerName,
groupName: groupName,
attributes: {
model: 'Model A',
serialNumber: 'SN111',
integrationName: metadata['integrationName']
},
telemetry: {
temperature: 42,
humidity: 80,
rawData: payloadStr
}
};
/** Helper functions **/
function decodeToString(payload) {
return String.fromCharCode.apply(String, payload);
}
function decodeToJson(payload) {
// covert payload to string.
var str = decodeToString(payload);
// parse string to JSON
var data = JSON.parse(str);
return data;
}
return result;Downlink Converter Configuration
{
"decoder":null,
"encoder":"// Encode downlink data from incoming Rule Engine message\n\n// msg - JSON message payload downlink message json\n// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.\n// metadata - list of key-value pairs with additional data about the message\n// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter\n\n/** Encoder **/\n\nvar data = {};\n\n// Process data from incoming message and metadata\n\ndata.tempFreq = msg.temperatureUploadFrequency;\ndata.humFreq = msg.humidityUploadFrequency;\n\ndata.devSerialNumber = metadata['ss_serialNumber'];\n\n// Result object with encoded downlink payload\nvar result = {\n\n // downlink data content type: JSON, TEXT or BINARY (base64 format)\n contentType: \"JSON\",\n\n // downlink data\n data: JSON.stringify(data),\n\n // Optional metadata object presented in key/value format\n metadata: {\n topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'\n }\n\n};\n\nreturn result;"
}Encoder field in the more readable form:
// Encode downlink data from incoming Rule Engine message
// msg - JSON message payload downlink message json
// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
// metadata - list of key-value pairs with additional data about the message
// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
/** Encoder **/
var data = {};
// Process data from incoming message and metadata
data.tempFreq = msg.temperatureUploadFrequency;
data.humFreq = msg.humidityUploadFrequency;
data.devSerialNumber = metadata['ss_serialNumber'];
// Result object with encoded downlink payload
var result = {
// downlink data content type: JSON, TEXT or BINARY (base64 format)
contentType: "JSON",
// downlink data
data: JSON.stringify(data),
// Optional metadata object presented in key/value format
metadata: {
topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
}
};
return result;Available for users with 'TENANT_ADMIN' authority.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/converter/testDownLink
Returns a JSON object representing the result of the processed incoming message.
Request Body Example
{
"metadata":{
"data":"40"
},
"msg":"{\n \"temp\": 42,\n \"humidity\": 77\n}",
"msgType":"POST_TELEMETRY_REQUEST",
"integrationMetadata":{
"integrationName":"Integration"
},
"encoder":"// Encode downlink data from incoming Rule Engine message\n\n// msg - JSON message payload downlink message json\n// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.\n// metadata - list of key-value pairs with additional data about the message\n// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter\n\n/** Encoder **/\n\nvar data = {};\n\n// Process data from incoming message and metadata\n\ndata.tempValue = msg.temp;\ndata.humValue = msg.humidity;\n\ndata.devSerialNumber = metadata['ss_serialNumber'];\n\n// Result object with encoded downlink payload\nvar result = {\n\n // downlink data content type: JSON, TEXT or BINARY (base64 format)\n contentType: \"JSON\",\n\n // downlink data\n data: JSON.stringify(data),\n\n // Optional metadata object presented in key/value format\n metadata: {\n topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'\n }\n\n};\n\nreturn result;"
}- 'metadata' - message metadata pushed from the rule engine;
- 'msg' - message data pushed from the rule engine;
- 'msgType' - type of the message pushed from the rule engine;
- 'integrationMetadata' - integration metadata object;
- 'encoder' - string representation of the encoder configuration.
Response Body Example
{
"contentType":"JSON",
"data":"{\"tempValue\":42,\"humValue\":77}",
"metadata":{
"topic":"sensor/Temp Sensor/upload"
}
}- 'contentType' - downlink data content type;
- 'data' - downlink data;
- 'metadata' - optional metadata object.
body :
Accept : 'application/json'
Content-Type : 'application/json'POST /api/converter/testUpLink
Returns a JSON object representing the result of the processed incoming message.
Request Body Example
{
"metadata":{
},
"payload":"ewogICAgImRhdGEiOiAiZGF0YSIKfQ==",
"decoder":"// Decode an uplink message from a buffer\n// payload - array of bytes\n// metadata - key/value object\n\n/** Decoder **/\n\n// decode payload to string\nvar payloadStr = decodeToString(payload);\n\n// decode payload to JSON\n// var data = decodeToJson(payload);\n\nvar deviceName = 'Device A';\nvar deviceType = 'thermostat';\nvar customerName = 'customer';\nvar groupName = 'thermostat devices';\n// use assetName and assetType instead of deviceName and deviceType\n// to automatically create assets instead of devices.\n// var assetName = 'Asset A';\n// var assetType = 'building';\n\n// Result object with device/asset attributes/telemetry data\nvar result = {\n// Use deviceName and deviceType or assetName and assetType, but not both.\n deviceName: deviceName,\n deviceType: deviceType,\n// assetName: assetName,\n// assetType: assetType,\n customerName: customerName,\n groupName: groupName,\n attributes: {\n model: 'Model A',\n serialNumber: 'SN111',\n integrationName: metadata['integrationName']\n },\n telemetry: {\n temperature: 42,\n humidity: 80,\n rawData: payloadStr\n }\n};\n\n/** Helper functions **/\n\nfunction decodeToString(payload) {\n return String.fromCharCode.apply(String, payload);\n}\n\nfunction decodeToJson(payload) {\n // covert payload to string.\n var str = decodeToString(payload);\n\n // parse string to JSON\n var data = JSON.parse(str);\n return data;\n}\n\nreturn result;"
}- 'metadata' - integration metadata;
- 'payload' - base64 string representation of the data;
- 'decoder' - string representation of the decoder configuration.
Response Body Example
{
"output":"{\"deviceName\":\"Device A\",\"deviceType\":\"thermostat\",\"customerName\":\"customer\",\"groupName\":\"thermostat devices\",\"attributes\":{\"model\":\"Model A\",\"serialNumber\":\"SN111\"},\"telemetry\":{\"temperature\":42,\"humidity\":80,\"rawData\":\"{\\n \\\"data\\\": \\\"data\\\"\\n}\"}}",
"error":""
}- 'output' - string representation of the output message;
- 'error' - string representation of the error message.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/converter/{converterId}
Fetch the Converter object based on the provided Converter Id. The server checks that the converter is owned by the same tenant.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
converterId : string
Accept : 'application/json'DELETE /api/converter/{converterId}
Deletes the converter and all the relations (from and to the converter). Referencing non-existing converter Id will cause an error. If the converter is associated with the integration, it will not be allowed for deletion.
Security check is performed to verify that the user has 'DELETE' permission for the entity (entities).
converterId : string
Accept : 'application/json'GET /api/converter/{converterId}/debugIn
Returns a JSON object of the latest debug event representing the input message the converter processed.
Uplink Converter Debug Input Event Example
{
"inContentType":"JSON",
"inContent":"{\"temp\":40}",
"inMetadata":"{\"Header:sec-ch-ua\":\"\\\"Chromium\\\";v=\\\"94\\\", \\\"Google Chrome\\\";v=\\\"94\\\", \\\";Not A Brand\\\";v=\\\"99\\\"\",\"Header:user-agent\":\"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.71 Safari/537.36\",\"integrationName\":\"Integration\",\"Header:cookie\":\"GUID=zYSs8hymSwZKv8kHALKY; redirect_to=%2F; JSESSIONID=B0A7C8E481409CE7924E738DB04F62F9\",\"Header:sec-ch-ua-platform\":\"\\\"Linux\\\"\",\"Header:accept\":\"*/*\",\"Header:origin\":\"http://localhost:8080\",\"Header:sec-fetch-site\":\"same-origin\",\"Header:connection\":\"keep-alive\",\"Header:accept-encoding\":\"gzip, deflate, br\",\"Header:content-type\":\"application/json\",\"Header:content-length\":\"16\",\"Header:sec-fetch-mode\":\"cors\",\"Header:sec-ch-ua-mobile\":\"?0\",\"Header:sec-fetch-dest\":\"empty\",\"Header:host\":\"localhost:8080\",\"Header:referer\":\"http://localhost:8080/swagger-ui.html\",\"Header:accept-language\":\"en-US,en;q=0.9,ru-RU;q=0.8,ru;q=0.7,uk;q=0.6,und;q=0.5\"}"
}- 'inContentType' - content type of the message received by the integration;
- 'inContent' - message data received;
- 'inMetadata' - integration metadata (e.g. headers).
Downlink Converter Debug Input Event Example
{
"inContentType":"JSON",
"inContent":"{\"temp\":42,\"humidity\":77}",
"inMsgType":"POST_TELEMETRY_REQUEST",
"inMetadata":"{\"data\":\"40\"}",
"inIntegrationMetadata":"{\"integrationName\":\"Integration\"}"
}- 'inContentType' - content type of the message received by the integration;
- 'inContent' - content of the message pushed from the rule engine;
- 'inMsgType' - type of the message pushed from the rule engine;
- 'inMetadata' - content of the message metadata pushed from the rule engine;
- 'inIntegrationMetadata' - integration metadata.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
converterId : string
Accept : 'application/json'GET /api/converters{?converterIds}
Requested converters must be owned by tenant which is performing the request.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
converterIds : string
Accept : 'application/json'GET /api/converters{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of converters owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/customMenu/currentCustomMenu
Fetch the Custom Menu object that corresponds to the authority of the user. The API call is designed to load the custom menu items for edition. So, the result is NOT merged with the parent level configuration. Let's assume there is a custom menu configured on a system level. And there is no custom menu items configured on a tenant level. In such a case, the API call will return empty object for the tenant administrator.
Security check is performed to verify that the user has 'READ' permission for the white labeling resource.
Accept : 'application/json'GET /api/customMenu/customMenu
Fetch the Custom Menu object for the end user. The custom menu is configured in the white labeling parameters. If custom menu configuration on the tenant level is present, it overrides the menu configuration of the system level. Similar, if the custom menu configuration on the customer level is present, it overrides the menu configuration of the tenant level.
Accept : 'application/json'POST /api/customMenu/customMenu
Creates or Updates the Custom Menu configuration.
Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/customTranslation/currentCustomTranslation
Fetch the Custom Translation map that corresponds to the authority of the user. The API call is designed to load the custom translation items for edition. So, the result is NOT merged with the parent level configuration. Let's assume there is a custom translation configured on a system level. And there is no custom translation items configured on a tenant level. In such a case, the API call will return empty object for the tenant administrator.
Response example:
{"translationMap":{"es_ES":"{\"home\":\"MyHome\"}"}}Security check is performed to verify that the user has 'READ' permission for the white labeling resource.
Accept : 'application/json'GET /api/customTranslation/customTranslation
Fetch the Custom Translation map for the end user. The custom translation is configured in the white labeling parameters. If custom translation translation is defined on the tenant level, it overrides the custom translation of the system level. Similar, if the custom translation is defined on the customer level, it overrides the translation configuration of the tenant level.
Accept : 'application/json'POST /api/customTranslation/customTranslation
Creates or Updates the Custom Translation map.
Request example:
{"translationMap":{"es_ES":"{\"home\":\"MyHome\"}"}}Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/customer/{customerId}
Get the Customer object based on the provided Customer Id. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerId : string
Accept : 'application/json'DELETE /api/customer/{customerId}
Deletes the Customer and all customer Users. All assigned Dashboards, Assets, Devices, etc. will be unassigned but not deleted. Referencing non-existing Customer Id will cause an error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for the entity (entities).
customerId : string
Accept : 'application/json'GET /api/customer/{customerId}/shortInfo
Get the short customer object that contains only the title and 'isPublic' flag. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerId : string
Accept : 'application/json'GET /api/customer/{customerId}/title
Get the title of the customer. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerId : string
Accept : 'application/json'GET /api/customers{?customerIds}
Returns a list of Customer objects based on the provided ids. Filters the list based on the user permissions.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerIds : string
Accept : 'application/json'GET /api/customers{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of customers owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'POST /api/customer{?entityGroupId}
Creates or Updates the Customer. When creating customer, platform generates Customer Id as time-based UUID. The newly created Customer Id will be present in the response. Specify existing Customer Id to update the Customer. Referencing non-existing Customer Id will cause 'Not Found' error.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
entityGroupId : string
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/entityGroup/{entityGroupId}/customers{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of Customer objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Security check is performed to verify that the user has 'READ' permission for specified group.
entityGroupId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/tenant/customers{?customerTitle}
Get the Customer using Customer Title.
Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerTitle : string
Accept : 'application/json'GET /api/user/customers{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of customers available for the user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/customer/dashboard/home/info
Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the corresponding customer.
Available for users with 'CUSTOMER_USER' authority.
Security check is performed to verify that the user has 'READ' permission for the white labeling resource.
Accept : 'application/json'POST /api/customer/dashboard/home/info
Update the home dashboard assignment for the current customer.
Available for users with 'CUSTOMER_USER' authority.
Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/dashboard/home
Returns the home dashboard object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases).
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
Accept : 'application/json'GET /api/dashboard/home/info
Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
Accept : 'application/json'GET /api/dashboard/info/{dashboardId}
Get the information about the dashboard based on 'dashboardId' parameter. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON.
dashboardId : string
Accept : 'application/json'GET /api/dashboard/maxDatapointsLimit
Get the maximum number of data points that dashboard may request from the server per in a single subscription command. This value impacts the time window behavior. It impacts 'Max values' parameter in case user selects 'None' as 'Data aggregation function'. It also impacts the 'Grouping interval' in case of any other 'Data aggregation function' is selected. The actual value of the limit is configurable in the system configuration file.
Accept : 'application/json'GET /api/dashboard/serverTime
Get the server time (milliseconds since January 1, 1970 UTC). Used to adjust view of the dashboards according to the difference between browser and server time.
Accept : 'application/json'GET /api/dashboard/{dashboardId}
Get the dashboard based on 'dashboardId' parameter. The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases).
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
dashboardId : string
Accept : 'application/json'DELETE /api/dashboard/{dashboardId}
Delete the Dashboard. Only users with 'TENANT_ADMIN') authority may delete the dashboards.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
dashboardId : string
Accept : 'application/json'GET /api/dashboards{?dashboardIds}
Returns a list of DashboardInfo objects based on the provided ids. Filters the list based on the user permissions.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
dashboardIds : string
Accept : 'application/json'POST /api/dashboard{?entityGroupId}
Create or update the Dashboard. When creating dashboard, platform generates Dashboard Id as time-based UUID. The newly created Dashboard id will be present in the response. Specify existing Dashboard id to update the dashboard. Referencing non-existing dashboard Id will cause 'Not Found' error. Only users with 'TENANT_ADMIN') authority may create the dashboards.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
entityGroupId : string
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/entityGroup/{entityGroupId}/dashboards/export{?limit}
Export the dashboards that belong to specified group id.The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases).
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group.
entityGroupId : string
limit : integer
Accept : 'application/json'POST /api/entityGroup/{entityGroupId}/dashboards/import{?overwrite}
Import the dashboards to specified group.The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases).
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group.
entityGroupId : string
overwrite : boolean
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/entityGroup/{entityGroupId}/dashboards{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of Dashboard objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group.
entityGroupId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/tenant/dashboard/home/info
Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the corresponding tenant.
Available for users with 'TENANT_ADMIN' authority.
Security check is performed to verify that the user has 'READ' permission for the white labeling resource.
Accept : 'application/json'POST /api/tenant/dashboard/home/info
Update the home dashboard assignment for the current tenant.
Available for users with 'TENANT_ADMIN' authority.
Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource.
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/tenant/dashboards{?mobile,page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of dashboard info objects owned by the tenant of a current user. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' authority.
pageSize : integer
page : integer
mobile : boolean
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/tenant/{tenantId}/dashboards{?page,pageSize,sortOrder,sortProperty,textSearch}
Returns a page of dashboard info objects owned by tenant. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'SYS_ADMIN' authority.
tenantId : string
pageSize : integer
page : integer
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'GET /api/user/dashboards{?mobile,operation,page,pageSize,sortOrder,sortProperty,textSearch,userId}
Returns a page of Dashboard Info objects available for specified or current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
pageSize : integer
page : integer
mobile : boolean
textSearch : string
sortProperty : string
sortOrder : string
operation : string
userId : string
Accept : 'application/json'DELETE /api/customer/device/{deviceName}/claim
Reclaiming means the device will be unassigned from the customer and the device will be available for claiming again.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'CLAIM_DEVICES' permission for the entity (entities).
deviceName : string
Accept : 'application/json'POST /api/customer/device/{deviceName}/claim{?subCustomerId}
Claiming makes it possible to assign a device to the specific customer using device/server side claiming data (in the form of secret key).To make this happen you have to provide unique device name and optional claiming data (it is needed only for device-side claiming).Once device is claimed, the customer becomes its owner and customer users may access device data as well as control the device. In order to enable claiming devices feature a system parameter security.claim.allowClaimingByDefault should be set to true, otherwise a server-side claimingAllowed attribute with the value true is obligatory for provisioned devices. See official documentation for more details regarding claiming.
Available for users with 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'CLAIM_DEVICES' permission for the entity (entities).
deviceName : string
subCustomerId : string
body :
Accept : 'application/json'
Content-Type : 'application/json'GET /api/customer/{customerId}/devices{?page,pageSize,sortOrder,sortProperty,textSearch,type}
Returns a page of devices objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
customerId : string
pageSize : integer
page : integer
type : string
textSearch : string
sortProperty : string
sortOrder : string
Accept : 'application/json'POST /api/device-with-credentials{?entityGroupId}
Create or update the Device. When creating device, platform generates Device Id as time-based UUID. Requires to provide the Device Credentials object as well. Useful to create device and credentials in one request. You may find the example of LwM2M device and RPK credentials below:
{
"device": {
"name": "LwRpk00000000",
"type": "lwm2mProfileRpk"
},
"credentials": {
"id": "null",
"createdTime": 0,
"deviceId": "null",
"credentialsType": "LWM2M_CREDENTIALS",
"credentialsId": "LwRpk00000000",
"credentialsValue": {
"client": {
"endpoint": "LwRpk00000000",
"securityConfigClientMode": "RPK",
"key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ=="
},
"bootstrap": {
"bootstrapServer": {
"securityMode": "RPK",
"clientPublicKeyOrId": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4Z2 years ago