Filter by keyword

Issue Field Option Property Index

On This Page

    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 { "path": "category", "type": "text", "name": "categoryName" }

    Properties

    path
    Type
    string
    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
    string
    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:

    • number, which is indexed as a number and allows the range ordering and searching on this field.
    • text, which is tokenized before indexing and allows searching for particular words.
    • string which is indexed as is and allows searching for the exact phrase only.
    • user, which is indexed as a user and allows user-based searching. The expected value is an account ID string (a universal Atlassian user identifier).

    • date, which is indexed as a date with time and allows date-based searching.

      The value is expected to be a date string in one of the following formats:

      • [YYYY]-[MM]-[DD]
      • [YYYY]-[MM]-[DD]T[hh]:[mm]Z
      • [YYYY]-[MM]-[DD]T[hh]:[mm]+[hh]:[mm]
      • [YYYY]-[MM]-[DD]T[hh]:[mm]-[hh]:[mm]

      See ISO_8601 standard for reference.

    name
    Type
    string
    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: