Using Jira Cloud REST API, how to get details of specific fields

Amir Katz _Jira Admin_
Contributor
October 8, 2024

As per the documentation, the following endpoint (/rest/api/latest/field), which is documented here, supports the 'id' query parameter, which is a list of one or more field IDs, comma-separated.

I am doing that, but instead of getting the two fields that I specified, I'm getting all the fields in our Jira instance. No error is returned.

It seems that the parameters 'startAt' and 'maxResults' are honored, but others (like 'id' and 'expand') are ignored.

If I use the endpoint /rest/api/latest/field/search, I get error 400 - bad request.

What am I doing wrong here?

Thanks

4 answers

1 accepted

0 votes
Answer accepted
Amir Katz _Jira Admin_
Contributor
October 14, 2024

The response from Atlassian support was good.

The IDs for the specific fields must be specified like this:

id='customfield_<nnnnn>'

for system field, you specify the name.

So to get the fields 'Description' and custom field 12345, you must specify:

.../field/search?id=Description&id=customfield_12345
1 vote
David Bakkers
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
October 8, 2024

the following endpoint (/rest/api/latest/field), which is documented here, supports the 'id' [and 'expand'] query parameter[s].

No it doesn't...

Request

This request has no parameters

and..

It seems that the parameters 'startAt' and 'maxResults' are honored

Nope. Those two parameters are ignored by that endpoint too.

Amir Katz _Jira Admin_
Contributor
October 13, 2024

Bummer...do you whether there is an open bug to Atlassian?

0 votes
Amir Katz _Jira Admin_
Contributor
October 16, 2024

As I said earlier, a solution was provided by Atlassian support.

In addition, I suggested that an enhancement request should be created to better document the REST API endpoint, and they created one:

https://jira.atlassian.com/browse/JRACLOUD-84979

I encourage everyone who reads this thread to visit the link and vote for it.

0 votes
Amir Katz _Jira Admin_
Contributor
October 13, 2024

Just submitted a support ticket, will update here about what Atlassian says.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
PREMIUM
TAGS
AUG Leaders

Atlassian Community Events