DriveDevices

post

DriveDevices

Provide a command to execute on a specific device. Supported commands of a device are
listed in the capabilities object returned by the GET /device and GET /device/{deviceId}/
Request format:
• name: String. Required. The name of the command to execute. It refers to the name of the capability.
• parameters: Array<object>. Optional. Array of the different required parameters for the
respective capability name. Some commands require parameters whereas others do not.
Each parameter must have the following properties: name ( String. Required. The name of this parameter. It is the one defined in the respective capability object.) and value (Type of this property is induced by its definition in the respective capability object. Required)
Response format:
• jobId: String. Id of the command request and execution associated.
This value is unique in the Somfy’s cloud and allows us to track each execution.

Resource URL

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

Header Parameters


Name Values Description
Content-Type

Body Parameters


Name Values Description
command
(required)

Request Body

deviceId Provide a command to execute on a specific device. Supported commands of a device are
listed in the capabilities object returned by the GET /device and GET /device/{deviceId}/
Request format:
• name: String. Required. The name of the command to execute. It refers to the name of the capability.
• parameters: Array<object>. Optional. Array of the different required parameters for the
respective capability name. Some commands require parameters whereas others do not.
Each parameter must have the following properties: name ( String. Required. The name of this parameter. It is the one defined in the respective capability object.) and value (Type of this property is induced by its definition in the respective capability object. Required)
Response format:
• jobId: String. Id of the command request and execution associated.
This value is unique in the Somfy’s cloud and allows us to track each execution.
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...