When setting a field value, the post-function will fail to work as expected, if the input value does not match the expected field type. This document describes the format of values expected by a field when set using a post-function.
The value can be a text provided in the
Value field of:
- Set field value post-function
- Set field value of linked issues post-function
- "User entity properties" of User properties editor page, to copy the value of the specified user property for the current user using Set field value from User Entity Property value post-function
The value can be the result of a Nunjucks template provided in the
Value field of:
The value can be specified as text. It can be:
a simple, constant String. For example:
This is a description
the String representation of a
Number. For example:
Date. The expected format is ISO_8601. For example:
Complex (object) field. In this case, the value should be the String representation of that object. For example, to set the Fix Version/s to version 2.0, you would use the following value:
Multiple values (for multi-valued fields) can be provided, separated by commas. For example, to specify two Affects Versions 1.0 and 2.0 write
1.0,2.0 in the Value.
For detailed information about the exact format of the expected value for each field, see:
- Text value - Standard Jira fields
- Text value - Predefined Custom fields
- Text value - User-created custom fields
You can also inject Nunjucks annotations into the text value. You might also want to look at Accessing an issue or a transition using Nunjucks annotations.
You can use the Set Field Value post-function to clear a field value by leaving the
Value field empty. Ensure that neither
Ignore empty value nor
Add value(s) to the field options is selected.
The value can be specified as a JSON value, which is a text representation of data that can be passed to Jira. This requires the
Treat value as JSON option to be selected.
Supported value types include:
- String. For example:
"This is a description"
- Number. For example:
- Date. This must be a String containing an ISO_8601 date. For example:
- Object. The object must contain at least one field (different from id) which allows the object to be identified unambiguously. For example, a user can be specified as:
For multi-valued fields, the value(s) must be provided as an array of values, even if only one value is provided. For example, to set the Fix Versions field to "2.0":
For detailed information about the JSON value expected by each field type, see
- JSON value - Standard Jira fields
- JSON value - Predefined Custom fields
- JSON value - User-created custom fields
You can also inject Nunjucks annotations into the JSON value. You might also want to look at Accessing an issue or a transition using Nunjucks annotations.
You can use the
null JSON value to clear a field (assuming the field is not required, like Summary, Description or Resolution).