Info about a workflow state
| name | data type | description |
|---|---|---|
| name | string | Name of the state |
| nameTranslation | string | State name translation |
| description | string | Description of the state |
| transitions | StateTransitions | Available state transitions from this state |
| final | boolean | True if is a final state |
| taskable | boolean | True if tasks can be set in this state |
| changeDueDate | boolean | True if due date can be changed by users |
| hideFromPath | boolean | True if the state is hidden from the workflow progress tracker |
| dueDate | string | Time period before the state expires (ISO 8601 format) or exact date when the state expires |
| colour | string | Colour of the state |
| approvals | array of Approval | List of available approvals in this state |
Example
{
"name" : "Draft",
"nameTranslation" : "Borrador",
"description" : "State of pages under construction",
"transitions" : {
"approved" : {
"state" : "...",
"parameters" : [ { }, { } ]
},
"rejected" : {
"state" : "...",
"parameters" : [ { }, { } ]
},
"updated" : {
"state" : "...",
"parameters" : [ { }, { } ]
},
"expired" : {
"state" : "...",
"parameters" : [ { }, { } ]
},
"submit" : {
"state" : "...",
"parameters" : [ { }, { } ]
},
"completed" : {
"state" : "...",
"parameters" : [ { }, { } ]
},
"select" : [ {
"state" : "...",
"parameters" : [ { }, { } ]
}, {
"state" : "...",
"parameters" : [ { }, { } ]
} ]
},
"final" : false,
"taskable" : true,
"changeDueDate" : false,
"hideFromPath" : true,
"dueDate" : "P2D",
"colour" : "#FFAB00",
"approvals" : [ {
"name" : "Approval 1",
"weight" : 10,
"label" : "label1",
"credentials" : "password",
"approvers" : {
"users" : "user1,user2,user3",
"groups" : "confluence-users,confluence-administrators",
"minimum" : "*"
},
"conditions" : [ {
"permission" : [ "edit", "view" ],
"clause" : "...",
"type" : "..."
}, {
"names" : [ "Editor in Chief", "Reviewer" ],
"value" : "...",
"clause" : "...",
"type" : "..."
}, {
"states" : [ "state_1", "state_2" ],
"clause" : "...",
"type" : "..."
}, {
"spaceKey" : "SP1",
"clause" : "...",
"type" : "..."
}, {
"page" : "Page 1",
"clause" : "...",
"type" : "..."
}, {
"users" : "user_1,user_2,user_3",
"clause" : "...",
"type" : "..."
}, {
"groups" : "group_1,group_2,group_3",
"clause" : "...",
"type" : "..."
}, {
"users" : "user_1,user_2,user_3",
"clause" : "...",
"type" : "..."
}, {
"groups" : "group_1,group_2,group_3",
"clause" : "...",
"type" : "..."
}, {
"excludedUsers" : "user_1,user_2,user_3",
"clause" : "...",
"type" : "..."
}, {
"approval" : "Review Approval",
"current" : true,
"clause" : "...",
"type" : "..."
}, {
"labels" : [ "label_1", "label_2" ],
"clause" : "...",
"type" : "..."
} ]
}, {
"name" : "Approval 2",
"weight" : 1,
"label" : "label2",
"credentials" : "userid+password",
"approvers" : {
"users" : "user6",
"groups" : "confluence-users",
"minimum" : "3+"
},
"conditions" : [ {
"permission" : [ "view", "edit" ],
"clause" : "...",
"type" : "..."
}, {
"names" : [ "Reviewer", "Editor in Chief" ],
"value" : "...",
"clause" : "...",
"type" : "..."
}, {
"states" : [ "state_2", "state_1" ],
"clause" : "...",
"type" : "..."
}, {
"spaceKey" : "...",
"clause" : "...",
"type" : "..."
}, {
"page" : "...",
"clause" : "...",
"type" : "..."
}, {
"users" : "...",
"clause" : "...",
"type" : "..."
}, {
"groups" : "...",
"clause" : "...",
"type" : "..."
}, {
"users" : "...",
"clause" : "...",
"type" : "..."
}, {
"groups" : "...",
"clause" : "...",
"type" : "..."
}, {
"excludedUsers" : "...",
"clause" : "...",
"type" : "..."
}, {
"approval" : "...",
"current" : true,
"clause" : "...",
"type" : "..."
}, {
"labels" : [ "label_2", "label_1" ],
"clause" : "...",
"type" : "..."
} ]
} ]
}