getFieldChanges

Owned by Alexandra Topoloaga (Unlicensed)
Last updated: Oct 22, 2021 by Jonathan Muse

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

The availability of the users personal data may be impacted by the recent changes by Atlassian in order to meet GDPR compliance. See the following for more information:

Availability

This routine is available starting with katl-commons 4.0.4.

This routine is available for Jira server and cloud deployment options.

Syntax

getFieldChanges(key, history_field_name)

Description

Returns a list of tuples containing user|changeDate|field|oldVal|newVal for the selected field from the selected issue's history. Updated in v 4.8.0.8 to include two new fields - oldValString & newValString.

Parameters

Parameter name

Type

Required

Description

issue key

String

Yes

Key of the selected issue.

field name

String

Yes

Name of the selected field.

Return type

JFieldChange []

The return value is an array of JFieldChange. The strings come in pairs. The first value is a date representing the time when the value was modified and the second value is the content of the requested field at that date.

Example

JFieldChange[] changes  = getFieldChanges("TEST-10", "My Text Field");

return changes;

Result: 

admin|2017-05-23 13:28:05|My Text Field||test|admin|2017-05-23 13:28:09|My Text Field|test|lalaa


Example 2

Let's say we want to get the latest change for the given field:

JFieldChange[] changes  = getFieldChanges("TEST-10", "customfield_10200");

JFieldChange latestChange = changes[0];
date newest = latestChange.changeDate;

for (JFieldChange change in changes) {
    if (change.changeDate > newest) {
        latestChange = change;
    }
}
return latestChange;

Done. Program returned: admin|2017-05-23 13:28:09|Text Field|aaaaa|nnnnn

Notes

  1. Besides the labels/ids of the custom fields, the name of the standard Jira fields (summary, assignee etc.) can be used as parameters.
  2. If it returns an empty array, you must get the last value of the field from the issue.
  3. The second parameter is the field name as it appears in history.

See also