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; } } }

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

Amir Katz (Jira Admin)

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

Accepted answers

Amir Katz (Jira Admin)

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

All comments

unknown

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)

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

Amir Katz (Jira Admin)

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

Amir Katz (Jira Admin)

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

Amir Katz (Jira Admin)

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.

Welcome!

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

Quick Links

Find more posts tagged with

custom-field

cloud

rest-api

jira-cloud