API error

RuntimeError: POST https://xxxxxx.atlassian.net/rest/api/3/search/jql failed [400]: {'errorMessages': ['Invalid request payload. Refer
to the REST API documentation and try again.']}
Stuck on this error. Any thoughts or inputs on this?

3 answers

2 accepted

Comments for this post are closed

Community moderators have prevented the ability to post new answers.

4 votes

Answer accepted

Hello,

Welcome to community :)

We have edited the url from the post as it would be visible to all

As per the error Jira rejected the JSON body shape itself, not the JQL.
So it’s almost certainly one of:

Wrong JSON structure for the new /search/jql endpoint
Invalid / non‑JSON body
Missing required field in the body

Could you please let us know what are you trying to post using api?

Thank you

Prachi

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

I am trying to get the custom field values and its context for a project, it was throwing an error using get, so used POST for this.

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

1 vote

Answer accepted

Welcome @Addakula Sri Sai Venkata Lalitha Yasonadh Yashwanth

Error message appears to be legit referring that your payload is invalid. What is the body of your request? What were you trying to do with the request?

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

payload = {

"jql": f"project={project_key}",

"startAt": start_at,

"maxResults": MAX_RESULTS,

}

Payload shape required by the API:

{ "queries": [ { "jql": "...", "startAt": 0, "maxResults": 50, "fields": ["..."] } ] }

Response shape:

{ "responses": [ { "issues": [...], "total": 123, "startAt": 0, "maxResults": 50 } ] }

I am trying to get the custom field values and its context for a project, it was throwing an error using get, so used POST for this. I have used these.

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Have you checked this article? https://www.postman.com/api-evangelist/atlassian-jira/request/ep9zobc/get-options-for-field

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Like • Staffan Redelius likes this

0 votes

Adding to above please also check our change log : https://developer.atlassian.com/changelog/#CHANGE-2046

It has new end points that can be used for API

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Was this helpful?

Thanks!

Jira

DEPLOYMENT TYPE

CLOUD

PRODUCT PLAN

ENTERPRISE

Forums

Q&A

Community resources

Support

Top groups

Community resources

Support

Learn

Community resources

Support

Events

Community resources

Support

API error

3 answers

2 accepted

Comments for this post are closed

Was this helpful?

Thanks!

DEPLOYMENT TYPE

PRODUCT PLAN

TAGS

Community showcase

Atlassian Community Events