Skip to main content
Browse Documentation
HTTP - Management

Workflow definition color

Created by c.neale on 24 Sep 2020

A color that exists on various properties of a workflow to control the display of the entry at different points in its workflow.

 

Can be any one of the following string values:

  • red
  • green
  • orange
  • blue
  • gray
  • purple
  • hotPink
  • cyan
  • lime
  • ruby
  • lightGray
  • yellow

Property

Example

This example shows the color "blue" being used in a workflow event

{
    "id": "submit",
    "name": {
        "en-GB": "Send for approval"
    },
    "description": {
        "en-GB": "Send the entry for approval"
    },
    "transitionTo": "awaitingApproval",
    "exitActions": [
        {
        "invokeAction": "validateEntry"
        }
    ],
    "color": "blue",
    "groupId": "submitRevoke",
    "uiAction": "navigateToEntryListing",
    "parameters": [
        {
            "id": "message",
            "name": {
                "en-GB": "Add an optional message for the approver"
            },
            "dataType": "string",
            "dataFormat": null,
            "description": {
                "en-GB": "The message included with the entry submission"
            },
            "default": null,
            "validations": {},
            "editor": {
                "id": "multiline",
                "instructions": {
                    "en-GB": "Optionally include a message to let an approver understand your changes"
                },
                "properties": null
            }
        }
    ]
}