Issue Field Option Property Index

Defines an issue field option property to be indexed by Jira. An option can contain an additional properties object. In this bean, you can define which properties will be extracted, so that a user will be able to search for issues which have options set that have a certain property.

Note that multi_select fields may have more than one option selected. In that case, properties from all options are indexed. Each Option's properties should have the same structure to be indexed properly, i.e. the types of values across all options' properties should not differ. If they do, Jira will still try to act smart and do the most reasonable thing, but the results are not guaranteed.

Example

1
2
3
4
5
6
{
  "path": "category",
  "type": "text",
  "name": "categoryName"
}

Properties

path
Type
Required
Yes
Description

The path to the JSON data which is supposed to be indexed.

For instance, for JSON "{"label": {"color": "red", "text":"connect"}} the valid path referencing the color is label.color.

Currently, specifying of index for JSON arrays and first level JSON (such as "true") is not supported. The JSON needs to be an object with properties.


type
Type
Required
Yes
Allowed values
  • number
  • NUMBER
  • text
  • TEXT
  • string
  • STRING
  • user
  • USER
  • date
  • DATE
Description

The type of the referenced value.

The type can be one of the following values:


name
Type
Description

The name, under which this property will be searchable with JQL. If not given, the

1
path

will be used. For a field with name Field Name, and an extraction with name ExtractionName the resulting query string will be "Field Name".ExtractionName.


Rate this page: