Parameter Name | Description | Required |
id | ID of the custom action | true |
allowedroletypes | List of role types allowed for the action | false |
cleanupdetails | Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action) | false |
cleanupparameters | Optional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action) | false |
description | The description of the command | false |
details | Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0 | false |
enabled | Whether the action is enabled or not | false |
errormessage | Error message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionName | false |
parameters | Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true | false |
resourcetype | Type of the resource for actions | false |
successmessage | Success message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionName | false |
timeout | Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds | false |