Issue Field Property

Defines an issue property that will store the value for the issue field of the read_only type.

Example

1
2
3
4
5
{
  "path": "comments.count",
  "key": "statistics",
  "type": "number"
}

Properties

key

Type
string
Required
Yes
Description

The key of the issue property.

path

Type
string
Required
Yes
Description

The path to the value in the JSON object.

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

type

Type
string
Allowed values
  • number
  • NUMBER
  • string
  • STRING
  • date
  • DATE
    • Required
    Yes
    Description

    The type of the referenced value. It will affect how the value is interpreted and displayed, and how the field behaves in JQL.

    The type can be one of the following:

    • number, which is displayed as a number and allows the range ordering and searching on this field.
    • string, which supports a string, for example "example text", and a list of strings, for example ["example text1", "example text2"]. The string is displayed as is and enables a search for matching phrases. The list is displayed as comma-separated values and enables a search for matches to any phrase from the list.

    • date, which is displayed as a date with time and allows date-based searching.

      The value is expected to be a date string in one of the following formats:

      • [YYYY]-[MM]-[DD]
      • [YYYY]-[MM]-[DD]T[hh]:[mm]Z
      • [YYYY]-[MM]-[DD]T[hh]:[mm]+[hh]:[mm]
      • [YYYY]-[MM]-[DD]T[hh]:[mm]-[hh]:[mm]

      See ISO_8601 standard for reference.