Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

How can I know which fields can be displayed on the UI or not?

ZSuite Tester October 1, 2024

Specific Issue API: /rest/api/3/issue/{ISSUE_ID}

For this specific issue API, there are no properties available to indicate whether these fields can be displayed on the Jira native UI or not. Therefore, while constructing the result with this API, I don't know whether I can render these fields. Can you provide a solution

3 answers

0 votes
Jim Knepley - ReleaseTEAM
Atlassian Partner
October 1, 2024

Hi @ZSuite Tester

Jira is designed to administer at scale, so they use reusable components called "schemes" to define which fields appear on screens, which I think is what you're talking about when you say "the Jira native UI."

You'll need to do some additional work with the API to identify the screen scheme a project uses and which fields appear on which screens. Depending on your environment, this could range from relatively easy to somewhat difficult.

0 votes
Aaron Pavez [ServiceRocket]
Community Champion
October 1, 2024

Hi @ZSuite Tester 

The cloud API list doesn't show what you are requesting. What exactly do you want to know that? For your own app or script?

There is no limitation on which fields you can add to the SCREENS. All Jira fields are supported to be added to a particular screen. Some Third party fields wont be compatible.

Are you looking for something in particular? Whats your use case?

Regards

Aaron

ZSuite Tester October 1, 2024

Hi Aaron,

I'm actually trying to construct a UI that shows specific issues in Jira. All the modules—Epics, Tasks, Bugs, and Custom Issue Types—fall under the general Issue Type category. I have a specific issue ID, but the UI fields displayed vary based on the issue type and project type. For many of the custom fields, the 'getSpecificIssue' API returns null values, so I'm unsure whether I should include these fields while building the UI.

Aaron Pavez [ServiceRocket]
Community Champion
October 1, 2024

Hi @ZSuite Tester 

As @Lucas Modzelewski _Lumo_ mentioned, you will get better answers in the Dev community

https://community.developer.atlassian.com/ 

And as @Jim Knepley - ReleaseTEAM mentioned, you need to deal with screens and field configurations and all that.

you might be missing a call to something else to get that information.

Regards

0 votes
Lucas Modzelewski _Lumo_
Atlassian Partner
October 1, 2024

In Jira fields are displayed based on screen configuration (create, edit, view) set in screen schemes also be aware that fields can have different values based on context.

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/#api-group-screens 

You can try to get deeper into technical details in the developer community: https://community.developer.atlassian.com/ 

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