Workflow event parameters
Log in to add to favouritesProperties
| Name | Type | Format | Description |
|---|---|---|---|
| id | string | - | The identifier for the parameter. |
| name | object | localized value | The friendly name given to the parameter. |
| description | object | localized value | The description given to the parameter. |
| dataType | string | - | This should be set to "string". |
| default | object | - | This should be set to null. |
| validations | object[...] | validation | The validation to be used. |
| editor | object | editor | The editor to be used. |
Example
This example shows a parameter as used in a workflow definition.
{
"id": "decline",
"name": {
"en-GB": "Decline"
},
"auditText": {
"en-GB": "Declined"
},
"description": {
"en-GB": "Decline the entry for approval"
},
"transitionTo": "declined",
"color": "red",
"groupId": "approveDecline",
"uiAction": "navigateToEntryListing",
"validate": false,
"parameters": [
{
"id": "message",
"name": {
"en-GB": "Add a message to explain to the author why this content is being declined"
},
"dataType": "string",
"dataFormat": null,
"description": {
"en-GB": "The decline reason"
},
"default": null,
"validations": {
"required": {
"message": {
"en-GB": "The decline reason is required"
}
}
},
"editor": {
"id": "multiline",
"instructions": {
"en-GB": "Include a message to let an approver know your changes"
},
"properties": null
}
}
]
}