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.

entityType

Type
string
Defaults to
issue
Allowed values
  • issue
    • Description

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

    key

    Type
    string
    Description

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

    For most modules a key does not have to be specified as a random key will be assigned for each module. A key only needs to be specified when it needs to be known for use in other modules or content.

    For example, if you need to create a page and have the content of the page link to iteself or another page module you'll need to specify the key(s) for the page(s) so that you can determine the url to link to.

    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"

    keyConfigurations

    Type
    [ Index Key Configuration, … ]
    Description

    List of properties from which selected values are indexed.