Get
|
|||||
|
|
Gets command data a specific command issued to the device
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your Chrome OS devices' metadata
- View your Chrome OS devices' metadata
Input
This building block consumes 3 input parameters
Name | Format | Description |
---|---|---|
customerId Required |
STRING |
Immutable. Immutable ID of the G Suite account |
deviceId Required |
STRING |
Immutable. Immutable ID of Chrome OS Device |
commandId Required |
INTEGER |
Immutable. Immutable ID of Chrome OS Device Command |
= Parameter name
= Format
customerId STRING Required Immutable. Immutable ID of the G Suite account |
deviceId STRING Required Immutable. Immutable ID of Chrome OS Device |
commandId INTEGER Required Immutable. Immutable ID of Chrome OS Device Command |
Output
This building block provides 10 output parameters
Name | Format | Description |
---|---|---|
commandExpireTime |
ANY |
The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired |
commandId |
INTEGER |
Unique ID of a device command |
type |
ENUMERATION |
The type of the command |
state |
ENUMERATION |
Indicates the command state |
commandResult |
OBJECT |
The result of executing a command |
commandResult.errorMessage |
STRING |
The error message with a short explanation as to why the command failed. Only present if the command failed |
commandResult.executeTime |
ANY |
The time at which the command was executed or failed to execute |
commandResult.result |
ENUMERATION |
The result of the command |
payload |
STRING |
The payload that the command specified, if any |
issueTime |
ANY |
The timestamp when the command was issued by the admin |
= Parameter name
= Format
commandExpireTime ANY The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired |
commandId INTEGER Unique ID of a device command |
type ENUMERATION The type of the command |
state ENUMERATION Indicates the command state |
commandResult OBJECT The result of executing a command |
commandResult.errorMessage STRING The error message with a short explanation as to why the command failed. Only present if the command failed |
commandResult.executeTime ANY The time at which the command was executed or failed to execute |
commandResult.result ENUMERATION The result of the command |
payload STRING The payload that the command specified, if any |
issueTime ANY The timestamp when the command was issued by the admin |