Skip to end of banner
Go to start of banner

getFieldChanges

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Availability

This routine is available starting with katl-commons 4.0.4

Syntax

getFieldChanges(key, history_field_name)

Description

Returns a list of tuples containing user||field|oldVal|newVal for the selected field from the selected issue's history.

Parameters

Parameter name

Type

Required

Description

issue key

String

Yes

the key of the selected issue

field name

String

Yes

the name of the selected field

Return type

JFieldChanges []

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. Beside the labels/ids of the custom fields, also 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

 

  • No labels