GetDevicesByDeviceId

get

GetDevicesByDeviceId

Get a specific device for the current device. It allows you to retrieve information such as its state for this specific device.
Request format:
• siteId: String. Required. The ID of the end-user site. This value is unique in the Somfy’s cloud.
Response format:
• id: String. The ID of the device. This value is unique in the Somfy’s cloud.
• label: String. The name of the device. This can be a friendly name given by the end-user in the Somfy’s app or a default name attributed after being paired.
• type: String. The type of the device. This value characterizes the definition of the product.
• siteId: String. The ID of the end-user site which device belongs to. This value is unique in the Somfy’s cloud.
• states: Array<object>. Array of the different states of the device. Zero or more states are returned (zero state meaning the device does not support state reporting or is stateless, it is the case for RTS devices and hubs for example). Each state has the following properties: name ( String. The name of this state. ), value ( Type will be induced by the type property of the same object. The current or last known value for this specific state. ) and type ( String. The type of the value for this state. It is usually an integer or a string. )
• capabilities: Array<object>. Array of the different capabilities of the device. Zero or more capabilities are returned (zero capability meaning the device does not support any command, it is the case for hubs for example). Each capability has the following properties: name ( String. The name of the capability. ) and parameters ( Array<object>. Array of the different parameters to include in the body of the request to send a command to a device. Zero or more parameters are returned (zero parameter meaning that no parameter is required for this capability). Each parameter has the following properties: name ( String. The name of this parameter. ) and type ( String. The type of the value expected for this parameter. ))

Resource URL

https://api.somfy.com/api/v1 /device/{deviceId}

Header Parameters


Name Values Description
Content-Type

Request Body

deviceId Get a specific device for the current device. It allows you to retrieve information such as its state for this specific device.
Request format:
• siteId: String. Required. The ID of the end-user site. This value is unique in the Somfy’s cloud.
Response format:
• id: String. The ID of the device. This value is unique in the Somfy’s cloud.
• label: String. The name of the device. This can be a friendly name given by the end-user in the Somfy’s app or a default name attributed after being paired.
• type: String. The type of the device. This value characterizes the definition of the product.
• siteId: String. The ID of the end-user site which device belongs to. This value is unique in the Somfy’s cloud.
• states: Array<object>. Array of the different states of the device. Zero or more states are returned (zero state meaning the device does not support state reporting or is stateless, it is the case for RTS devices and hubs for example). Each state has the following properties: name ( String. The name of this state. ), value ( Type will be induced by the type property of the same object. The current or last known value for this specific state. ) and type ( String. The type of the value for this state. It is usually an integer or a string. )
• capabilities: Array<object>. Array of the different capabilities of the device. Zero or more capabilities are returned (zero capability meaning the device does not support any command, it is the case for hubs for example). Each capability has the following properties: name ( String. The name of the capability. ) and parameters ( Array<object>. Array of the different parameters to include in the body of the request to send a command to a device. Zero or more parameters are returned (zero parameter meaning that no parameter is required for this capability). Each parameter has the following properties: name ( String. The name of this parameter. ) and type ( String. The type of the value expected for this parameter. ))
null true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...