Create a Device Configuration Action
post
/api/config/Actions
Creates a new device configuration action.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionName: string
Action NameExample:
Example Action Name
-
Actions: array
Actions
-
ResultTimeout: integer
Timeout for all commandsExample:
30
Nested Schema : items
Type:
Show Source
object
-
ActionOrder: integer
The 0-based order to run commandsExample:
1
-
ConfigActionProfileID: integer
ID linking the action back to the parent actions profile.Example:
2
-
DisplayActionOutput: boolean
Whether to save output of commandExample:
0
-
ReadAction: string
Change Prompt before running commandExample:
Example Read Action
-
WriteAction: string
Command to runExample:
Example Write Action
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new device configuration action.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : configActionsRead
Type:
Show Source
object
-
ActionCount: integer
The number of actions to be executed.Example:
1
-
ActionName: string
Descriptor for the group of actions to be executed.Example:
Example Action Name
-
Actions: array
Actions
-
ConfigActionProfileID: integer
Config Action Profile IDExample:
1001
-
ResultTimeout: integer
Timeout for all commandsExample:
30
Nested Schema : items
Type:
Show Source
object
-
ActionOrder: integer
The 0-based order to run commandsExample:
1
-
ConfigActionProfileID: integer
ID linking the action back to the parent actions profile.Example:
2
-
DisplayActionOutput: boolean
Whether to save output of commandExample:
0
-
ReadAction: string
Change Prompt before running commandExample:
Example Read Action
-
WriteAction: string
Command to runExample:
Example Write Action
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object