Workflow state
Log in to add to favouritesProperties
| Name | Type | Format | Description |
|---|---|---|---|
| id | string | - | An identifier for the state, which must be unique within the workflow. |
| name | object | localized value | The friendly name given to the state. |
| events | object[...] | event | A collection of events that can occur to an entry in this state. |
| color | string | color | The color to be displayed in the Contensis UI for the state. |
| uiEditorView | string | ui editor view | The view used by the Contensis UI to display the entry when it is in this state. |
| allowUpdates | boolean | - | Indicates if updates are allowed in the current state. Defaults to true, set this to false to prevent authors from saving entries in the current state. |
Example
This example shows an awaiting approval workflow state and its associated events.
{
"id": "awaitingApproval",
"name": {
"en-GB": "Awaiting approval"
},
"events": [
{
"id": "revoke",
"name": {
"en-GB": "Revoke and edit"
},
"auditText": {
"en-GB": "Revoked"
},
"description": {
"en-GB": "Revoke the entry submission"
},
"transitionTo": "draft",
"color": "white",
"groupId": "submitRevoke",
"uiAction": "none",
"validate": false,
"parameters": []
},
{
"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
}
}
]
},
{
"id": "approve",
"name": {
"en-GB": "Approve"
},
"auditText": {
"en-GB": "Approved"
},
"description": {
"en-GB": "Approve the entry changes for publishing"
},
"transitionTo": "sysWorkflow",
"color": "green",
"groupId": "approveDecline",
"uiAction": "navigateToEntryListing",
"validate": false,
"parameters": []
}
],
"color": "yellow",
"uiEditorView": "previousPublishedVersionCompare",
"allowUpdates": false
}