set-expiration trigger action

1 Overview | 2 "set-expiration" | 2.1 ❗️ Mandatory parameter | 2.2 Example trigger code | 3 Related Pages

Overview

The "set-expiration" trigger action is used to add or update the due date for a workflow state.

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.

`"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 the Confluence user preferred 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"}
	]}
]

The "dueDate" in the above example is set using ISO 8601 format. For example, adding P6M3W5D adds a due date period that is 6 months, 3 weeks, and 5 days. This overrides any existing due date.

An existing expiration period can be removed using the "clear-expiration" action.