getFields

Description

Get the value of a a set of fields for the given Jira issue.

Parameters

Returns

Returns a Promise to the value; you must use await.

Returns an array of values, each of their own data type.

Examples

Get the Affects versions and Fix versions of the issue.

const vers = await api.issue.getFields(issue, ["versions","fixVersions"])
return json.stringify(vers)

Returns:

{"versions":
  [
    {
      "self":"https://api.atlassian.com/ex/jira/<id>/rest/api/2/version/10001",
      "id":"10001",
      "description":"",
      "name":"2.0",
      "archived":false,
      "released":false
    },
    {
      "self":"https://api.atlassian.com/ex/jira/<id>/rest/api/2/version/10002",
      "id":"10002",
      "description":"",
      "name":"1.9",
      "archived":false,
      "released":true,
      "releaseDate":"2024-09-24"
    }
  ],
"fixVersions":
  [
    {
      "self":"https://api.atlassian.com/ex/jira/<id>/rest/api/2/version/10000",
      "id":"10000",
      "description":"",
      "name":"2.1",
      "archived":false,
      "released":false
    }
  ]
}

Get the Labels and Components of the issue’s Parent.

const parentIssue = await api.issue.getParentIssue(issue)
const assignedTo = await api.issue.getFields(parentIssue, ["labels","components"]) 
return json.stringify(assignedTo)

Returns:

{"labels":
  ["leadApproved","needsDocs"],
"components":
  [
    {
      "self":"https://api.atlassian.com/ex/jira/<id>/rest/api/2/component/10032",
      "id":"10032",
      "name":"Authentication"
    },
    {
      "self":"https://api.atlassian.com/ex/jira/<id>/rest/api/2/component/10033",
      "id":"10033",
      "name":"Infrastructure"
    }
  ]
}

You are viewing the documentation for Jira Cloud.

On this page

Determining custom field IDs

There are several ways to determine the field ID of a custom field; the most straightforward is to check the URL of the custom field when editing its details through the Jira Custom fields screen. To find the ID of a custom field:

Log into Jira as an Administrator.
In the upper right corner of the window, click Settings ( ⚙️ ) and select Issues.
In the left-hand sidebar, click Custom fields.
Locate your custom field in the list; use the filter at the top of the list to search.
Click the action button at the far right ( ) and select Edit details.
Check the URL for the page that opens - the final argument of the URL is the field ID (Figure 1, right).
Append this value to “customfield_” to get the full ID of the field. For example, customfield_10130 is the field ID of Projected Due Date, shown in Figure 1, right.