Download field data dictionary (Name and data type of all fields)

Abhinandan Maheshwari September 11, 2023

Hello Team,

I need to download all the field and its data type for each work item in JIRA.

Major requirement is to download custom fields and its data type in JSON/XML format.

 

Please suggest, if we have some mechanism to do the same.

 

Thanks,

Abhi

 

 

1 answer

0 votes
Matthias Gaiser _K15t_
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
September 11, 2023

Hi @Abhinandan Maheshwari

welcome to the Atlassian Community.

There is a REST API endpoint which lists all available fields within a Jira instance including the type information. The url is constructed like this:

BASE_URL/rest/api/3/field

You can see an example response here: https://ecosystem.atlassian.net/rest/api/3/field.

Is this what you're looking for?

Cheers,
Matthias.

Abhinandan Maheshwari September 13, 2023

Thanks a lot for Support

Abhinandan Maheshwari September 13, 2023

@Matthias Gaiser _K15t_ 

When I downloaded this JSON, for sub task I see below configuration, where as in User Story, it is showing as Sub-task (without s), Please suggest, what is correct name for Subtask,  as I need to show this field in my application which shows all the JIRA work items and related fields.

{
"id": "subtasks",
"key": "subtasks",
"name": "Sub-tasks",
"custom": false,
"orderable": false,
"navigable": true,
"searchable": false,
"clauseNames": [
"subtasks"
],
"schema": {
"type": "array",
"items": "issuelinks",
"system": "subtasks"
}
},

Matthias Gaiser _K15t_
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
September 13, 2023

I'd still go ahead and use the name property to display them. Subtasks are a bit different because in Jira's UI, it's not only showing the value, but also resolving the actual issues in to clickable links.

For other fields, the name property should be what you want.

Like Abhinandan Maheshwari likes this

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
FREE
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events