Versions Compared

Old Version 39

changes.mady.by.user Nadiia Lisovska

Saved on

compared with

New Version Current

changes.mady.by.user Nadiia Lisovska

Saved on

Key

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

...

Panel
bgColor#E3FCEF

POST​/integration/app/rest/api/v1/secure-field/search

​

The endpoint allows the searching of issues based on secure field values.

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
titleRequest body

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


Expand
titleSecure number


Request body example:

Code Block
themeRDark
UIREST 

Image Added


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




Expand
titleSecure text


UIREST

Image Added


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 10,
    "sort":
50 
 {
        "sortField": "Secure Text (multi-line)",
        "order": "ASC"
    },
    "criteriaList": [
        {
            "customFieldId": "66cccbfa6abc1c0d56fe087d",
            "operator": "CONTAIN",
            "value": "localhost"
        }
    ]
}




Expand
titleSecure date


UIREST

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
titleSecure group


UIREST

Image Added


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 30,
    "criteriaList": [
        {
            "customFieldId": "65dc98d4e25541421646964c",
            "operator": "NOT_IN",
            "value": "b8a78765-cea8-4a32-ad10-e7df715275ca"
            
        }
    ]
}





Expand
titleSecure list


UIREST

Image Added


Code Block
{
    "projectId": "10076",
    "page": 0,
    "numberOfIssuesOnPage": 30,
    "criteriaList": [
        {
            "customFieldId": "65dc98d4e25541421646964a",
            "operator": "NOT_EMPTY"
            
        }
    ]
}





Expand
titleSecure user


UIREST

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 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. 



Expand
titleResponse example


Code Block
themeRDark



[
    {
        "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

Status
colourGreen
title200
- OK. Returned if the request is successful.

...