Update Shadow

You can use this endpoint to update the shadow of a device.

URL

https://{{HOST}}/security/device/{deviceId}/shadow?v={version}

Method

POST

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Path Parameters

Name Description Type
deviceId
required		 The ID of the device. string

URL Query Parameters

Name Description Example Type
v
optional		 Version of the api to use /device?v=2.0 number

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token
Content-Type
required		 application/json Content Type

Request Body Parameters

Name Description Type
Object Name
required		 Description object definition
Reported
required		 Description object definition
Bound
required		 Description object definition
Discovery
required		 Description object definition
Revision
required		 Description object definition

Example

Request

curl -X POST 
  TODO Curl Request

Response

{
    "Reported":
    {
        "controlMode": "Circulating Air",
        "controlSchedule":
        [{ "day": 0, "startTime": 0700, "endTime": 1600, "state": "Away"}],
        "temperature": 78,
        "name": "TestGlasA",
        "setpoint": 69,
        "lifeStyleStatus": "Vacation",
        "temperatureControlMode": "Hold Override",
        "timestamp": 2016-08-25T09:25:00,
        "humidity": 74
    },
    "Bound": {},
    "Discovered": [
        {"Id": "GUID90", "DataLink": "Entity://GUID90"},
        {"Id": "GUID99", "DataLink": "Entity://GUID99"}
    ],
    "Hash": "blah",
    "Revision": 4,
    "AuditId": "blah",
    "DeviceType": 1
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
Reported Description object definition
Bound Description object definition
Discovered Description object definition
Hash Description object definition
Revision Description object definition
AuditId Description object definition
DeviceType Description object definition