Documentation

Entity Property

Entity properties allow add-ons to add key/value stores to JIRA entities, such as issues or projects. These values are indexed by JIRA and able to be queried via a REST api or through JQL. For more information, please see the JIRA documentation on entity properties.

Example

Properties

name

Type
i18n Property
Required
Yes
Description

A human readable name.

key

Type
string
Required
Yes
Description

A key to identify this module. This key must be unique relative to the add on.

All specified keys will have all special characters and spaces replaced with dashes and will be lower cased.

example: "My Addon Key" will become "my-addon-key"

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

entityType

Type
string
Defaults to
issue
Allowed values
  • issue
    • Description

    The type of the entity. The default value is issue.

    keyConfigurations

    Type
    [ Index Key Configuration, … ]
    Description

    List of properties from which selected values are indexed.