nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

I have issue with moving to new advance search API. Can anyone help? what is wrong with the jql??

Renata Liwanowska_grq85q

query:
{"expand":["names"],"jql":"project=ABC order by updated desc ","maxResults":200,"fieldsByKeys":false,"fields":["*all"]}

it does work with call to /rest/api/3/search
but not with /rest/api/3/search/jql

error:
Invoke-RestMethod : {"errorMessages":["Invalid request payload. Refer to the REST API documentation and try again."]}

Accepted answers

sai chinamuthevi

There is an error in your payload.

/rest/api/3/search is correct not /rest/api/3/search /jql

Jql you need to enter in Parameters, not in payload

unknown

You haven't said if you are using the GET or POST version of the endpoint, but if you refer to the documentation, you will find that the mistake is not in the JQL, but in the request structure.

If you are using the GET method, then you have made a number of mistakes:

The expand parameter is declared as a string of comma delimited values, not an array of strings.
The fields parameter is declared as a string of comma delimited values, not an array of strings (An array of strings is only for the POST method).
The maxResults parameter cannot return more than 100 results, unless you are asking the endpoint for only the field key or ID to be returned.

Lastly, the fieldByKeys parameter is false by default, so setting it to false serves no purpose.

I recommend that when you encounter such problems with your API requests, that you use an API test tool and break the request down into smaller parts, and test each part in isolation to see where you are making your mistake, rather than trying one big request that might have many mistakes.

Have fun

All comments

sai chinamuthevi

There is an error in your payload.

/rest/api/3/search is correct not /rest/api/3/search /jql

Jql you need to enter in Parameters, not in payload

unknown

Incorrect.

/rest/api/3/search is the wrong path. The correct path is /rest/api/3/search/jql

And, if the OP was using the POST method, the parameters would be declared in the request body.

unknown

You haven't said if you are using the GET or POST version of the endpoint, but if you refer to the documentation, you will find that the mistake is not in the JQL, but in the request structure.

If you are using the GET method, then you have made a number of mistakes:

The expand parameter is declared as a string of comma delimited values, not an array of strings.
The fields parameter is declared as a string of comma delimited values, not an array of strings (An array of strings is only for the POST method).
The maxResults parameter cannot return more than 100 results, unless you are asking the endpoint for only the field key or ID to be returned.

Lastly, the fieldByKeys parameter is false by default, so setting it to false serves no purpose.

Have fun

Renata Liwanowska_grq85q

I use POST
and I do pass all parameters in Body.

note: since /rest/api/3/search is about to be decommissioned I am looking how to replace it with the new API call.

Existing calls with rest/api/3/search are still working... but not sure for how long

Renata Liwanowska_grq85q

Thanks @[deleted]
It was the expand parameter.

Renata Liwanowska_grq85q

old API accepted Array of string.
new API, just list in a string.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

cloud

jira-cloud