POST https://.atlassian.net/rest/api/3/search this api has been deprecated.

Question

POST https://.atlassian.net/rest/api/3/search this api has been deprecated and new recommendation is https://.atlassian.net/rest/api/3/search/jql below is body { "jql": "assignee = currentUser() AND resolution = EMPTY", "startAt": 0, "maxResults": 50, "fields": [ "summary", "status", "assignee" ] } but getting error like below { "errorMessages": [ "Invalid request payload. Refer to the REST API documentation and try again." ] } what is the correct format and what is wrong in my payload and api url?

Marc -Devoteam- · Answer

Hi @MVaseem_Fathima

Welcome to the community.

See the new API endpoint, api-rest-api-3-search-jql-get

parameter  "startAt", doesn't exist anymore in the new search api endpoint.

unknown · Answer

Hello @MVaseem_Fathima

but getting error like below - "Invalid request payload..."

When you encounter such errors when sending requests to REST APIs you need to break the problem down into smaller pieces and systematically evaluate each step in creating the request so that you able to determine which specific part of your request is responsible for the error.

For example:

* Start by making the simplest request possible first. Submit a request to the endpoint and define only the value for the jql parameter.
* If that request works without error, add another parameter and value, such as the maxResults parameter with a value of 50, to the request,
* If that request works without error, systematically add the each of the other parameters and their values ONE BY ONE, testing each new combination in turn until you encounter which parameter and value declaration combination causes the fault.
* Once you have determined which parameter and value combination is causing the request to fail, refer to the documentation for the endpoint and confirm that:* That parameter is valid to use with that endpoint
* If it is a valid parameter, you have provided the value in the correct format

In this manner you will identify which parameter you have incorrectly used in your request body that has caused it to become invalid.

Good luck!

Rilwan Ahmed · Answer

Hi @MVaseem_Fathima ,

Welcome to the community !!

You can refer https://developer.atlassian.com/changelog/#CHANGE-2046 for more details about new api.