set-expiration trigger action
- Robert Alexander Marshall
Overview
When the workflow trigger event occurs, the trigger checks that any required conditions are met, and if met, the "set-expiration" action sets a new expiration date. The due date is a period in the ISO 8601 format.
One or more trigger actions can be set for a named event in the workflow.
"set-expiration"
"set-expiration" sets an expiry period for a state.
action (set-expiration)
dueDate❗️ Due date
period in ISO 8601 format
or specific date (in Confluence preferred user format for the site)
❗️ Mandatory parameter
dueDate
A value must be added for the due date.
Example trigger code
"triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final":true}
],
"actions":
[
{"action": "set-expiration",
"dueDate": "P6M"}
]}
] If adding the JSON trigger using workflow builder there is no need to include the opening "triggers": JSON markup notation, it is added automatically by workflow builder.
The "dueDate" period is set using ISO 8601 format. For example, "P6M3W5D" will be 6 months, 3 weeks, and 5 days from the date of transition into the state. This overrides any existing expiration periods.
An existing expiration period can be removed using the "clear-expiration" action.