Versions Compared

Key

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

...

Expand
titleRequest body

UI vs. REST call examples for different secure field types:


Expand
titleSecure number


UIREST 


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 10,
    "sort": {
        "sortField": "Secure Number",
        "order": "ASC"
    },
    "criteriaList": [
        {
            "customFieldId": "65dc98d4e255414216469654",
            "operator": "GREATER",
            "value": 5
        }
    ]
}





Expand
titleSecure textdate


UIREST

Image RemovedImage Added


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 1020,
    "sort": {
        "sortField": "Secure Text (multi-line)Date Picker",
        "order": "ASC"
    },
    "criteriaList": [
        {
            "customFieldId": "66cccbfa6abc1c0d56fe087d66cccbfa6abc1c0d56fe086d",
            "operator": "CONTAINLESS_EQUAL",
            "value": "localhost2024-09-01"
        }
    ]
}





date
Expand
titleSecure
text


UIREST
Image Removed

Image Added


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 
20
10,
    "sort": {
        "sortField": "Secure 
Date Picker
Text (multi-line)",
        "order": "ASC"
    },
    "criteriaList": [
        {
            "customFieldId": "
66cccbfa6abc1c0d56fe086d
66cccbfa6abc1c0d56fe087d",
            "operator": "
LESS_EQUAL
CONTAIN",
            "value": "
2024-09-01
localhost"
        }
    ]
}




Expand
titleSecure textdate


UIREST

Image RemovedImage Added


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 1020,
    "sort": {
        "sortField": "Secure Text (multi-line)Date Picker",
        "order": "ASC"
    },
    "criteriaList": [
        {
            "customFieldId": "66cccbfa6abc1c0d56fe087d66cccbfa6abc1c0d56fe086d",
            "operator": "CONTAINLESS_EQUAL",
            "value": "localhost2024-09-01"
        }
    ]
}




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. 


...