JIRA Development Cookbook - Third Edition

Searching on issue entity properties

JIRA has a nice feature where we can store key/value pairs on JIRA entities like issues or projects. To make it even better, JIRA allows us to search issues using the entity properties set on them using JQL or REST API.

JIRA uses a plugin module named Index Document Configuration to expose these issue properties as properties that can be indexed. Once indexed, they can be searched using JQL, just like any other issue fields.

In this recipe, we will see how we can use the Index Document Configuration plugin module to search on issue properties.

Getting ready

First, we need to populate an existing issue in JIRA with some properties. These properties have a key, and the value can be a JSON object.

Let us assume that ...