Searching:
0 results found
BackDevices/RemoveSetting
POST /odata/Devices/deviceId/removeSetting
Description
Axonize Device objects have a property named settings. Each setting property in settings correlates with a specific setting on the actual Device, which is managed by the Axonize Device SDK.
This endpoint removes a specific setting from the Axonize Device object properties so that it is no longer managed by Axonize.
See the following for request and response details ‒
See Also
Request ‒ Devices/RemoveSetting
| Property | Type | Description | Mandatory |
| settings | Array of Objects | Settings is an array of setting properties. Each setting property represents an Axonize Device object property to be modified on a physical Device in order to affect its functionality.
“settings”: [ { “name”: “string”, “desiredValue”: “string”, “reportedValue”: “string”, “lastSync”: “2018-08-24T11:14:32.000Z”, “version”: 0 } |
|
| settings/name | String | A free-text name for the property. This name must be recognized on the physical Device. | |
| settings/desiredValue | String | The value to be assigned to this property on the physical device. | |
| settings/reportedValue | String | The value received from the updated physical Device by the Axonize Device SDK as the updatedValue, after it has been updated. This value should be the same as the desiredValue (described above). | |
| settings/lastSync | DateTime | The last timestamp when a reading was received from the Device. | |
| settings/version | Integer | Not in use. |
Example JSON Devices/RemoveSetting Request
curl -X POST \
https://api.stg.axonize.com/odata/devices/5953a14cb637f914dc123456/removesetting \
-H ‘Content-Type: application/json’ \
-H ‘appId: 2925e8b9-259c-1234-afed-80a20d123456’ \
-H ‘Authorization: Token’ \
-d ‘{“settingName”: “humidity”}’
Response ‒ Devices/RemoveSetting
| Property | Type | Description |
| value | Boolean | Set to True if the removal of the setting was successful. |
Example JSON Devices/RemoveSetting Response
Status 200 – OK
{
“@odata.context”: “https://dev-axonizeapi-axonize.dev-ase-axonize.p.azurewebsites.net/odata/$metadata#Edm.Boolean”,
“value”: true
}