Skip to end of banner
Go to start of banner

Singe/Multiple select pickers with create

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

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.

Sample response from the API:

{
    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 documentation. Returns 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. 

The result can be filtered by one of these criteria:

  • id

  • fieldContextId

  • issueId

  • projectKeyOrId and issueTypeId

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).

Body parameter configurations, also required, contain the list of custom field configuration details. If you want to update the existing context configuration contextId must be provided, otherwise a unique id can be passed to create a new one.

In order to make this request successful, body should follow this scheme and it’s property names:

`{
  configurations: [
    {
      configuration: {
        options: [
          { label: "...", value: "<Unique Id>" },
          ...
          { label: "...", value: "<Unique Id>" },
        ]
      },
      contextId: "<Unique Id>"
    }
  ]
}`

Example of body parameter:

`{
  configurations: [
    {
      configuration: { 
        options: [
          { label: 'Option 1', value: 'option1' },
          { label: 'Option 2', value: 'option2' },
          { label: 'Option 3', value: 'option3' }
        ]
      },
      contextId,
    },
  ],
}`

  • No labels