Devices - Get Module Command History
Get module command history
GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}/modules/{moduleName}/commands/{commandName}?api-version=2022-07-31
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
base
|
path | True |
string |
The base domain for all Azure IoT Central service requests. |
command
|
path | True |
string |
Name of this device command. |
device
|
path | True |
string |
Unique ID of the device. |
module
|
path | True |
string |
Name of the device module. |
subdomain
|
path | True |
string |
The application subdomain. |
api-version
|
query | True |
string |
The version of the API being called. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
An error response received from the IoT Central Service. Headers x-ms-error-code: string |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get command history within module
Sample Request
GET https://appsubdomain.azureiotcentral.com/api/devices/mx1/modules/camera/commands/AdjustFrameRate?api-version=2022-07-31
Sample Response
{
"value": [
{
"response": "Success",
"responseCode": 200
}
]
}
Definitions
Name | Description |
---|---|
Device |
The device command definition. |
Device |
The paged results of device command executions. |
Error |
The response error definition. |
Error |
The detail information of the error. |
DeviceCommand
The device command definition.
Name | Type | Description |
---|---|---|
connectionTimeout |
integer |
Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. |
id |
string |
The request ID of the device command execution. |
request |
|
The payload for the device command, support any primitive types or object. |
response |
|
The payload of the device command response, support any primitive types or object. |
responseCode |
integer |
The status code of the device command response. |
responseTimeout |
integer |
Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. |
DeviceCommandCollection
The paged results of device command executions.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL to get the next page of device command executions. |
value |
The collection of device command executions. |
Error
The response error definition.
Name | Type | Description |
---|---|---|
error |
Error details for current request. |
ErrorDetails
The detail information of the error.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message details. |
requestId |
string |
Correlation Id for current request. |
time |
string |
The time that error request failed. |