Atlassian · Schema

JqlQueryFieldEntityProperty

Details of an entity property.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
entity string The object on which the property is set.
key string The key of the property.
path string The path in the property value to query.
type string The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/plat
View JSON Schema on GitHub

JSON Schema

atlassian-jqlqueryfieldentityproperty-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JqlQueryFieldEntityProperty",
  "title": "JqlQueryFieldEntityProperty",
  "description": "Details of an entity property.",
  "properties": {
    "entity": {
      "description": "The object on which the property is set.",
      "example": "issue",
      "type": "string"
    },
    "key": {
      "description": "The key of the property.",
      "example": "stats",
      "type": "string"
    },
    "path": {
      "description": "The path in the property value to query.",
      "example": "comments.count",
      "type": "string"
    },
    "type": {
      "description": "The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/) module.",
      "enum": [
        "number",
        "string",
        "text",
        "date",
        "user"
      ],
      "example": "number",
      "type": "string"
    }
  },
  "required": [
    "entity",
    "key",
    "path"
  ],
  "type": "object"
}