Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get Field ID

Using URL

Please note, that Administer Jira Global permission is necessary to complete these steps.

  1. Navigate to Settings (⚙) > Issues > Custom fields under the Fields section

    Click on the More () icon to the right of the custom field you are obtaining the ID

    Select the View field information option

  2. Observe the URL in your browser, which will contain the ID of the field. In the below example, the custom field ID is 10026.

...

Using API

Using the Get Fields Jira Cloud API endpoint, custom fields can be returned in a list. Please see the Cloud REST API documentation. The returned JSON data will need to be filtered to identify the field you are looking for and its ID.

...

Code Block
languagejson
{
    id: 'customfield_10026',
    key: 'multilevel-picker-field-type__customfield_10026',
    name: 'your-field-name',
    untranslatedName: 'your-field-name',
    custom: true,
    orderable: true,
    navigable: true,
    searchable: true,
    clauseNames: [ 'cf[10026]', 'your-field-name' ],
    schema: {
      type: 'object',
      custom: 'ari:cloud:ecosystem::extension/.../multilevel-picker-field-type',
      customId: 10026,
      configuration: [Object]
    }
  }

Get field configuration context Id

Using API

Get the configuration contextId of a custom field over Cloud REST API documentationReturns a paginated list of configurations for a custom field. Because every custom field type can hold different configurations, contextId is needed if you want to update a specific one. 

...

Otherwise, all configurations are returned.

Create/Update field configuration (options)

Using API

Update the configuration for contexts of a custom field over Cloud REST API documentation. This API requires path parameter fieldIdOrKey obtained from the above API (The ID or key of the custom field, for example, customfield_10026).

...