Page History

General Information

Throughout the documentation we refer to data types that can be used in Jira expression. The most commonly use data types are listed below. Apart from this list, learn more about data types in Jira expressions in the general documentation.

Numbers

All numbers in Jira expressions are double-precision 64-bit IEEE 754 floating points. The usual set of mathematical operations is available.

Strings can be converted to numbers with the Number function. For example:

Number('1') + Number('2') == 3

 Note that if a string cannot be parsed as number, the function returns NaN (Not a Number).

Texts 

Strings Texts are based on the JavaScript String object.

Currently supported properties and functions are:

Rich text

This object represents fields with rich text formatting. Currently it allows to retrieve only plain text, but in the future it will also contain Atlassian Document Format.

• plainText : The plain text stored in the field (

  Status
  subtle true title stringtext

  ).

To access such a property you can easily call it by using an expression like:

• issue.description.plainText

Dates 

This object is based on the JavaScript Date API.

Read more about dates and times in Jira expressions in the general documentation.

Jira expressions provide these additional functions:

Constructors

• new Date(): Creates a date that represents the current time.
• new Date(number): Creates a date based on a number of milliseconds that elapsed since the Unix epoch.
• new Date(string): Creates a date based on a string in the ISO 8601 format (for example, 2008-09-15T15:53:00+05:00). The current user's timezone is used if none is included in the string.

Calendar Date 

A time-zone agnostic Date with the same set of methods, but limited only to year, month, and day.

Constructors

• new CalendarDate(string): Creates a calendar date based on a string in the yyyy-MM-dd format. For example, 2018-09-15.

Lists 

Lists are a basic building block of Jira expressions. By design, the language does not support imperative constructs, so instead of writing loops, you need to employ the functional style of processing lists with lambda functions.

For example, to return the number of comments with contents longer than 100 characters:

1. first map the comments to their texts
2. then filter them to leave only those long enough
3. and finally get the length of the resulting list:

issue.comments                              
     .map(c => c.body.plainText)         
     .filter(text => text.length > 100)  
     .length

You can access individual elements of a list by using an index, e.g. issue.attachments[0].author.displayName returns the name of the author of the issue's first attachment.

The following properties and functions are available for lists:

Maps

If the returned property value is a JSON object, it will be converted to a Map.

• Static or dynamic member access can be used to retrieve values from a map. For example, map.key is the same as map['key'].
• Values can also be accessed using the get() method. For example, map.get('key').
• Both of these methods will return null if there is no mapping for the given key.

To create a new map, write new Map(). Object literals are also evaluated to the Map object. For example, { id: issue.id, summary: issue.summary } will evaluate to a map with two keys: id and summary.

Apart from static and computed member access, the following methods are available for maps:

• get(string): Returns the value mapped to the given key, or null (Any).
• set(string, Any): Returns a new map that has all entries from the current map, plus the first argument mapped to the second (Map).
• entries(): Returns a list of all entries in this map, each entry returned as a two-element list of key and value (List<[String, Any]>).

Constructors

• new Map(): Creates an empty map. Equivalent to {}.

Optional chaining

Accessing properties in a Jira expression may fail, for example, where:

• the left-hand side of the operation is null. For example, in the expression a.b where the value of a is null.

• the property does not exist.

In expressions where such strict rules are not desired, use the optional chaining operator ?.. This operator behaves in the same way as regular member access, but with one crucial difference: when accessing the property fails, null is returned.

Examples:

• issue.properties?.myProperty?.a?.b—this expression returns null if there is no myProperty defined in the issue, or if there is no a.b path in the value of the property.
• issue?.customfield_10010—this expression returns null if the custom field doesn't exist.

The operator can also be used in combination with computed member access, for example: issue?.[fieldName].

Boolean 

There are two boolean values: true and false.

The usual set of logical operators, with behavior following the rules of classical boolean algebra, is available: