Atlassian · Schema

FieldReferenceData

Details of a field that can be used in advanced searches.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
auto	string	Whether the field provide auto-complete suggestions.
cfid	string	If the item is a custom field, the ID of the custom field.
deprecated	string	Whether this field has been deprecated.
deprecatedSearcherKey	string	The searcher key of the field, only passed when the field is deprecated.
displayName	string	The display name contains the following: * for system fields, the field name. For example, `Summary`. * for collapsed custom fields, the field name followed by a hyphen and then the field name and fie
operators	array	The valid search operators for the field.
orderable	string	Whether the field can be used in a query's `ORDER BY` clause.
searchable	string	Whether the content of this field can be searched.
types	array	The data types of items in the field.
value	string	The field identifier.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FieldReferenceData",
  "title": "FieldReferenceData",
  "additionalProperties": false,
  "description": "Details of a field that can be used in advanced searches.",
  "properties": {
    "auto": {
      "description": "Whether the field provide auto-complete suggestions.",
      "enum": [
        "true",
        "false"
      ],
      "type": "string"
    },
    "cfid": {
      "description": "If the item is a custom field, the ID of the custom field.",
      "type": "string"
    },
    "deprecated": {
      "description": "Whether this field has been deprecated.",
      "enum": [
        "true",
        "false"
      ],
      "type": "string"
    },
    "deprecatedSearcherKey": {
      "description": "The searcher key of the field, only passed when the field is deprecated.",
      "type": "string"
    },
    "displayName": {
      "description": "The display name contains the following:\n\n *  for system fields, the field name. For example, `Summary`.\n *  for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`.\n *  for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.",
      "type": "string"
    },
    "operators": {
      "description": "The valid search operators for the field.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "orderable": {
      "description": "Whether the field can be used in a query's `ORDER BY` clause.",
      "enum": [
        "true",
        "false"
      ],
      "type": "string"
    },
    "searchable": {
      "description": "Whether the content of this field can be searched.",
      "enum": [
        "true",
        "false"
      ],
      "type": "string"
    },
    "types": {
      "description": "The data types of items in the field.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "value": {
      "description": "The field identifier.",
      "type": "string"
    }
  },
  "type": "object"
}