Documentation

Property Index

Defines an entity property to be indexed by JIRA. An entity property is a reference to a JSON object, which also defines it's type.

Example

Properties

objectName

Type
string
Required
Yes
Description

The objectName to the JSON data which is supposed to be indexed. The objectName will be the key of a flatten JSON object with '.' as the delimiter.

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

Currently, specifying of index for JSON arrays is not supported.

type

Type
string
Required
Yes
Allowed values
  • number
  • text
  • string
  • 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 phase only.
    • date, which is indexed as a date and allows date range searching and ordering. The expected date format is [YYYY]-[MM]-[DD]. The expected date time format is [YYYY]-[MM]-[DD]T[hh]:[mm] with optional offset from UTC: +/-[hh]:[mm] or Z for no offset. For reference, please see ISO_8601 standard.