Versions Compared

Key

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

...

Expand
titleResponse example


Code Block
themeRDark
{
    "total": 2,
    "page": 0,
    "pageSize": 10,
    "issueId": "10008",
    "items": [
        {
            "authorId": "5e8f9de61c07ed0b7df4063c",
            "secureFieldId": "64d25ee1ae45d1595276f16a",
            "secureFieldName": "Secure Number field",
            "oldValue": "7654.0",
            "newValue": "500.0",
            "created": 1691509448914
        },
        {
            "authorId": "5e8f9de61c07ed0b7df4063c",
            "secureFieldId": "64d25ee1ae45d1595276f16a",
            "secureFieldName": "Secure Number field",
            "oldValue": null,
            "newValue": "7654.0",
            "created": 1691508486073
        }
    ]
}


Search for secure fields

POST​


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. 


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. 







Responses

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

...