Summary
Run single command from template
Description
Run a single command from a template on a devices.
Route
POST /mop/RunCommandTemplateSingleCommand
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| templateId |
string |
yes |
Id of command template to be run. |
| commandIndex |
number |
yes |
Index of the command in the template |
| variables |
object |
yes |
Variables to be run with the Command Template. |
| devices |
array |
yes |
Devices to run the Command Template against. |
Copied to Clipboard
{
"templateId": "deserunt reprehenderit id",
"commandIndex": -97987310,
"variables": null,
"devices": []
}
Copied to Clipboard
{
"type": "object",
"properties": {
"templateId": {
"description": "Id of command template to be run.",
"type": "string"
},
"commandIndex": {
"description": "Index of the command in the template",
"type": "integer"
},
"variables": {
"description": "Variables to be run with the Command Template.",
"type": "object",
"properties": {},
"required": [
"variables"
],
"additionalProperties": false
},
"devices": {
"description": "Devices to run the Command Template against.",
"type": "array"
}
},
"required": [
"templateId",
"commandIndex",
"variables",
"devices"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| command_result |
object |
Result of the Command Template run. |
Copied to Clipboard
{
"command_result": true
}
Copied to Clipboard
{
"description": "Result of the Command Template run.",
"type": "object",
"properties": {
"command_result": true
},
"required": [
"command_result"
],
"additionalProperties": false
}
