...
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 (<), LESS_EQUAL (<=), GREATER (>), GREATER_EQUAL (>=)
Text fields: NOT_EMPTY, EQUALS (=), NOT_EQUALS (!=), CONTAIN (~), NOT_CONTAIN (!~)
Date fields: NOT_EMPTY, EQUALS (=), NOT_EQUALS (!=), LESS (<), LESS_EQUAL (<=), GREATER (>), GREATER_EQUAL (>=)
- Group fields: NOT_EMPTY, IN, NOT_IN
- List fields: NOT_EMPTY, IN, NOT_IN
- User fields: NOT_EMPTY, IN, NOT_IN.
Multiple criteria can be connected using AND operator.
Sorting order can be ASC or DESC.
| Info |
|---|
Use group ID/user ID to search for Secure user and secure group fields. |
| Expand |
|---|
|
UI vs. REST call examples for different secure field types:
| Expand |
|---|
|
| UI | REST |
|---|
 Image Added
| |
|
Request body example: | Code Block |
|---|
| {
1000710076",
"page": 0,
"numberOfIssuesOnPage": 10,
"sort": {
"sortField": "Secure Number",
"order": "ASC"
},
"criteriaList": [
{
"customFieldId": " |
|
65dc98d4e255414216469654",
"operator": "GREATER",
"value": |
|
|
| Expand |
|---|
|
| UI | REST |
|---|
 Image Added
|
| Code Block |
|---|
{
"projectId": "10076",
"page": 0,
"numberOfIssuesOnPage": 10,
"sort": {
"sortField": "Secure Text (multi-line)",
"order": "ASC"
},
"criteriaList": [
{
"customFieldId": "66cccbfa6abc1c0d56fe087d",
"operator": "CONTAIN",
"value": "localhost"
}
]
} |
|
|
| Expand |
|---|
|
| UI | REST |
|---|
 Image Added
|
| Code Block |
|---|
{
"projectId": "10076",
"page": 0,
"numberOfIssuesOnPage": 20,
"sort": {
"sortField": "Secure Date Picker",
"order": "ASC"
},
"criteriaList": [
{
"customFieldId": "66cccbfa6abc1c0d56fe086d",
"operator": "LESS_EQUAL",
"value": "2024-09-01"
}
]
} |
|
|
| Expand |
|---|
|
| UI | REST |
|---|
 Image Added
|
| Code Block |
|---|
{
"projectId": "10076",
"page": 0,
"numberOfIssuesOnPage": 30,
"criteriaList": [
{
"customFieldId": "65dc98d4e25541421646964c",
"operator": "NOT_IN",
"value": "b8a78765-cea8-4a32-ad10-e7df715275ca"
}
]
} |
|
|
| Expand |
|---|
|
| UI | REST |
|---|
 Image Added
|
| Code Block |
|---|
{
"projectId": "10076",
"page": 0,
"numberOfIssuesOnPage": 30,
"criteriaList": [
{
"customFieldId": "65dc98d4e25541421646964a",
"operator": "NOT_EMPTY"
}
]
} |
|
|
| Expand |
|---|
|
| UI | REST |
|---|
 Image Added
|
| Code Block |
|---|
{
"projectId": "10076",
"page": 0,
"numberOfIssuesOnPage": 10,
"criteriaList": [
{
"customFieldId": "66cccbfa6abc1c0d56fe0875",
"operator": "IN",
"value": "712020:51f069c5-053b-4b73-bc53-cf645e017ab7"
}
]
} |
|
|
Request structure | projectId* | Id of the project to search within | string (example: 10000) | | page | the number of the search result page to be shown | integer (example: 0) | | numberOfIssuesOnPage | number of the issues to be displayed per page | integer (example: 20) | | sort | sorting the search results by the field |
| | criteriaList* | list of search criteria |
| | customFieldId* | Id of the secure field to search | string (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 search | string (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 |
|---|
 Changes in criteria or sorting order must have a unique sessionId to obtain correct search results.
|
|
...