How to find the ID of a field in Jira for Jira Align integration

Related content

  • No related content found

Still need help?

The Atlassian Community is here for you.

Ask the community

Summary

When configuring the Jira Connector for Jira Align, field mapping under Jira Align's Admin > Jira Settings > Jira Setup may require verifying a Jira field's ID.

This article provides both UI and API methods to locate the ID of a field in Jira.

Environment

Jira Align

Solution

Jira User Interface

Result

  1. In a Jira project, click on Project Settings

  2. Click on Fields

  3. Find the field

  4. Hover over Screens link

  5. Wait and then check the URL preview at the bottom of the web browser for the fieldID


NOTE: If you cannot field the field in the UI, you may need to toggle on the 'Show Locked Fields' setting under 'Project Settings'

Jira API

Response

The same information can be retrieved through the API call to Jira, where all the fields present on the instance will be retrieved. The API would be a GET call, that can be done on the browser or using Postman/cURL, and it should look like this:
https://<jira-url>/rest/api/latest/field

{
        "id": "fixVersions",
        "key": "fixVersions",
        "name": "Fix versions",
        "custom": false,
        "orderable": true,
        "navigable": true,
        "searchable": true,
        "clauseNames":
        [
            "fixVersion"
        ],
        "schema":
        {
            "type": "array",
            "items": "version",
            "system": "fixVersions"
        }
    },
    {
        "id": "customfield_10077",
        "key": "customfield_10077",
        "name": "Approver groups",
        "untranslatedName": "Approver groups",
        "custom": true,
        "orderable": true,
        "navigable": true,
        "searchable": true,
        "clauseNames":
        [
            "Approver groups",
            "Approver groups[Group Picker (multiple groups)]",
            "cf[10077]"
        ],
        "schema":
        {
            "type": "array",
            "items": "group",
            "custom": "com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker",
            "customId": 10077
        }
    },

NOTE: To filter fields for a specific project and issue type:

https://<jira-url>/rest/api/2/issue/createmeta?expand=projects.issuetypes.fields&projectKeys=<jira-project-key>

replace <jira-project-key> with the actual Jira Project key






Last modified on Mar 19, 2024

Was this helpful?

Yes
No
Provide feedback about this article

Related content

  • No related content found
Powered by Confluence and Scroll Viewport.