OperationArgumentDefinition

OperationArgumentDefinition

JSON Example

{
    "id": "string",
    "name": "string",
    "description": "string",
    "group": "string",
    "type": "string",
    "subType": "string",
    "postValidate": false,
    "defaultValue": "string",
    "required": false,
    "enabled": false,
    "validationRegex": "string"
}

string

id

Optional

URN for operation argument

string

name

Required

Name for this operation argument

string

description

Optional

Description of this operation argument

string

group

Optional

Argument hierarchy

string

type

Optional

Type of this operation argument

Possible values are : BOOLEAN, INTEGER, STRING, PASSWORD, FILE,

string

subType

Optional

Sub type for this operation argument.

Possible values are : LABEL, TEXTAREA, PAGEHEADER, CHECKBOX, RADIOBUTTONS, PLAIN, PASSWORD, FILE, SELECTION, LIST, TIME_OF_WEEK_PICKER,

boolean

postValidate

Optional

Flag to indicate if changes to this field require recalculation of the config on the server.

string

defaultValue

Optional

Suggested value for the argument (Optional).

object

options

Optional

options

boolean

required

Optional

Is this a required OperationArgumentDefinition

boolean

enabled

Optional

Flag to indicate if this argument is required in the invocation request.

string

validationRegex

Optional

Optional regular expression to validate input

Property Of

Operation