Property description
The workflowStates asset creates workflow states which are used to build object workflows.
Minimal JSON
{
"key": "",
"name": "",
"iconKey": "",
"colorKey": ""
}{
"key": "approved",
"name": "Approved",
"description": "",
"state": "active",
"iconKey": "approved",
"colorKey": "approved",
"childCreationConditionallyDisabled": false
}Example taken from the core package.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey. | string | Yes |
name | Name of the asset, used as the default EN translation. | string | Yes |
iconKey | Key of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset. | string | Yes |
colorKey | Key of the color used to visually represent the asset. Use predefined colors from Settings > Configuration > Colors. For more information, see colors. | string | Yes |
attachmentUserRelationTypeKeys | Array of user relation types allowed to make changes (adding, deleting, editing) to attachments when the object is in a certain workflow state. Supported values are: NULL: When this property is not used, anyone with write permissions can make edits to attachments in this workflow state., core_steward: Only admins and space admins can make edits to attachments., user_role: Admins, space admins, and specified user role(s) can make edits to attachments. The user role(s) must:Havewritepermissions, Bedefined under**userRelationTypeKeys | array of strings | No |
childCreationConditionallyDisabled | Disables creation of child object in this workflow state. To use this proprerty, object type feature disable_child_creation_based_on_workflow_state has to be enabled. | boolean | No |
description | Description of the asset. | string | No |
disableMoveBasedOnWorkflowState | Disables moving objects that are in this workflow state. | boolean | No |
state | Current status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment). | string | No |
translations | Array of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations. | array | No |
userRelationTypeKeys | Array of keys of user relation types (= “workflow roles” like steward or business owner) allowed to edit an object in the current workflow state. If not specified, then all users can change the object in the current workflow state. | array of strings | No |