Versions Compared

Key

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

...

Only users with READ permission can utilise the endpoint. 

JQL operators

The availability of search operators varies depending on the type of secure field:

  • Number fields: NOT EMPTY, EQUALS (=), NOT EQUALS (!=), LESS THAN (<), LESS THAN EQUALS (<=), GREATER THAN (>), GREATER THAN EQUALS (>=)

  • Text fields: Not empty, =, !=, Contains, Not contains

  • Date fields: Not empty, =, !=, <, <=, >, >=

  • Group fields: Not empty, In, Not in
  • List fields: Not empty, In, Not in
  • User fields: Not empty, In, Not in.


Expand
titleRequest body

Request body example:

Code Block
themeRDark
 {
  "projectId": "10007",
  "page": 0,
  "numberOfIssuesOnPage": 10,
  "sort": {
    "sortField": "Secure Number",
    "order": "ASC"
  },
  "criteriaList": [
    {
      "customFieldId": "65f8a3f0be05d471ce104803",
      "operator": "GREATER",
      "value": 50
    }
  ]
  }

Request structure

projectId*Id of the project to search withinstring (example: 10000)
pagethe number of the search result page to be showninteger (example: 0)
numberOfIssuesOnPagenumber of the issues to be displayed per pageinteger (example: 20)
sortsorting the search results by the field
criteriaList*list of search criteria
customFieldId*Id of the secure field to searchstring (example: 65f8a3f0be05d471ce104803)
operator*JQL search operator string (example: LESS_EQUAL)
value*the specific secure field's value to search against (example: 5)
jqlFilter (optional)JQL filter to narrow the searchstring (example: created >= -30d)
sessionId unique session Id in UUID4 format generated by the user. Required for performance optimization when loading multiple pages. string (example: c769436b-76a0-4d2e-bed3-47aaa0790eab)


Info

(warning) Changes in criteria or sorting order must have a unique sessionId to obtain correct search results. 


...