v8

latestSwagger 2.02026-07-13120150263.9 KB

Run a module component command

Run a command on a module.

post/devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}

Path parameters

deviceIdstring required

Unique ID of the device.

moduleNamestring required

Name of the device module.

componentNamestring required

Name of the device component.

commandNamestring required

Name of this device command.

Query parameters

api-versionstring required

The version of the API being called.

Request body

idstring

The request ID of the device command execution.

connectionTimeoutinteger

Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.

responseTimeoutinteger

Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.

{"stackTrail":"components:schemas:DeviceCommand:properties:request","oasType":"schema","type":"unknown","description":"The payload for the device command, support any primitive types or object."}

{"stackTrail":"components:schemas:DeviceCommand:properties:response","oasType":"schema","type":"unknown","description":"The payload of the device command response, support any primitive types or object."}

responseCodeinteger

The status code of the device command response.

Response

Success