...
| Panel |
|---|
|
POST/integration/app/rest/api/v1/secure-field/search |
The endpoint allows the searching of issues based on secure field values.
...
| Expand |
|---|
|
Request body example: | Code Block |
|---|
| {
"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 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.
|
|
| Expand |
|---|
|
| Code Block |
|---|
|
[
{
"projectId": "10007",
"issueId": "13243",
"issueKey": "SGS-3176",
"issueTypeId": "10004",
"summary": "Story 2.0",
"secureFieldValues": {
"65f8a3f0be05d471ce104803": "70.0"
},
"secureFieldMetaData": {
"65f8a3f0be05d471ce104803": {
"customFieldId": "65f8a3f0be05d471ce104803",
"customFieldName": "Secure Number",
"issueTypeIds": [
"10000",
"10004",
"10005",
"10006",
"10007"
],
"fieldType": "SECURE_NUMBER",
"options": []
}
}
}
] |
|
Responses
- OK. Returned if the request is successful.
...