This message is used to request preset configurations for the device (for information on how to set configurations in RM see the Node Properties section in the Managing Devices page).
Request
Topic
backend/<device-type>/<device-id>/getsettingsPayload
{ "token" : <string>, "requestId" : <string>, "needAck" : <boolean>, "propertyNames" : <string[]>}"token"- this field is mandatory and is part of the security concept for the messaging protocol. For more information check the Security section in the MQTT Device Management Model page."requestId"and"needAck"- these fields are required if:message delivery acknowledgment is required;
confirmation of successful request is required (success is defined as an absence of error);
data is expected as a result of the request;
Note that if the fields are omitted no response of any kind will be sent by the backend and if an error has occurred the device won't be notified of it.
"propertyNames"- this field should contain the names of the preset configurations for the device, whose values are required. If the field is omitted, every available configuration will be returned.
Response
Topic
device/<device-type>/<device-id>/<token>/getsettingsPayload
{ "requestId" : <string>, "error" : <string>, "settings" : <map<string, object>>}"requestId"- this field will be included only if it was present in the request message and its value will match the value sent with the request."error"- this field will be included only if an error occurred during the fulfilling of the request. Note that if the field is present, the payload will not contain any other fields, except for"requestId"."settings"- this field will contain every requested configuration as a key-value pair, with the keys being the same as the"propertyNames"field in the request message.