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

1
2
3
4
5
6
{
  "objectName": "attachment.size",
  "type": "number",
  "alias": "attachmentSize"
}

Properties

objectName
Type
Required
Yes
Description

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

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

It is important to note that the objectName can refer to an array type, where the 'type' field in the extraction should be the type of each element in the specified array.


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:


alias
Type
Description

The name, under which this property will be searchable with JQL.