Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page properties
hiddentrue
Status
Tech review

Status
colourGreen
titledone

Style guide

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged

Page properties
hiddentrue
Short description
Filters an issue list using a given comparison for field values.
Output Statussubtletruetitleissue listAvailable since

Status
subtletrue
colourBlue
title2.1.21

UI Text Box
sizemedium
typeinfo

This function filters an issue list using the given comparison for number fields.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByFieldValue(issueList, numberField, operator, number) #Output: Issue list


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
filterByFieldValue(issuesUnderEpic(), {issue.cf10110}, >, 10)


This example returns an issue list with all issues under the current epic that have more than 10 story points assigned to them.

Note that {issue.cf10110} is in this example the field code for the field "Story Points".

To achieve this, the following functions are used:


Code Block
languagebash
linenumberstrue
filterByFieldValue(subtasks(), {issue.dueDate}, =, null)


This example returns an issue list with all sub-tasks that don't have a due date set.

To achieve this, the following functions are used:



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
issueList

Status
subtletrue
titleissue list

Any given issue list. Usually this value is retrieved from a function (e.g. linkedIssues() or subtasks()).
numberField

Status
subtletrue
titletext

Any field code representing a number field or a selectable field.
operator

Status
subtletrue
titleoperator

One of the following comparison operators: =, !=, <, <=, > and >=.
number

Status
subtletrue
titlenumber

Any given number or null that will be used in combination with the operator to filter the given list.



UI Expand
titleOutput

This function returns an

Status
subtletrue
titleissue list
.

If the issue list is empty or the comparison won't be fullfilled by any issue, the function returns an empty 

Status
subtletrue
titleissue list
.




UI Text Box
sizemedium
typeinfo

Variant for text fields.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByFieldValue(issueList, textField, operator, text) #Output: Issue list


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
filterByFieldValue(linkedIssues(), %{issue.component}, ~, "Web") 


This example returns an issue list with linked issues where the component "Web" is set.

To achieve this, the following functions are used:


Code Block
languagebash
linenumberstrue
filterByFieldValue(subtasks(), %{issue.status}, in, "Done, Closed, Canceled") 


This example returns an issue list with all sub-tasks that are in one of the specified status: Done, Closed or Canceled.

To achieve this, the following functions are used:


Code Block
languagebash
linenumberstrue
filterByFieldValue(siblingSubtasks(), %{issue.summary}, ~, %{issue.summary}) 


This example returns an issue list with all sibling sub-tasks that have the same summary like the current issue.

To achieve this, the following functions are used:


Code Block
languagebash
linenumberstrue
filterByFieldValue(subtasks(), %{issue.description}, ~, null)


This example returns an issue list with all sub-tasks of the current issue that don't have a description.

To achieve this, the following functions are used:



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
issueList

Status
subtletrue
titleissue list

Any given issue list. Usually this value is retrieved from a function (e.g. linkedIssues() or subtasks()).
textField

Status
subtletrue
titletext

Any field code representing a text field or a selectable field.
operator

Status
subtletrue
titleoperator

One of the allowed comparison operators.
text

Status
subtletrue
titletext

Any given text or null that will be used in combination with the operator to filter the text list.

Can also contain a comma separated list with strings.



UI Expand
titleOutput

This function returns an

Status
subtletrue
titleissue list
.

If the issue list is empty or the comparison won't be fullfilled by any issue, the function returns an empty 

Status
subtletrue
titleissue list
.


UI Text Box
typetip

If you want to filter by a more complex boolean expression, use the function filterByPredicate().

If you prefer using a JQL query to filter your results you can use issuesFromJQL()



Page properties
hiddentrue



Status
Tech review

Status
colourGreen
titledone

Style guide

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


Short description
Filters an issue list using a given comparison for field values.
Output

Status
subtletrue
titleissue list

Available since

Status
subtletrue
colourBlue
title2.1.21

Label