Atlassian · Schema

FieldDetails

Details about a field.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
clauseNames	array	The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).
custom	boolean	Whether the field is a custom field.
id	string	The ID of the field.
key	string	The key of the field.
name	string	The name of the field.
navigable	boolean	Whether the field can be used as a column on the issue navigator.
orderable	boolean	Whether the content of the field can be used to order lists.
schema	object	The data schema for the field.
scope	object	The scope of the field.
searchable	boolean	Whether the content of the field can be searched.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FieldDetails",
  "title": "FieldDetails",
  "additionalProperties": false,
  "description": "Details about a field.",
  "properties": {
    "clauseNames": {
      "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).",
      "items": {
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "custom": {
      "description": "Whether the field is a custom field.",
      "type": "boolean"
    },
    "id": {
      "description": "The ID of the field.",
      "type": "string"
    },
    "key": {
      "description": "The key of the field.",
      "type": "string"
    },
    "name": {
      "description": "The name of the field.",
      "type": "string"
    },
    "navigable": {
      "description": "Whether the field can be used as a column on the issue navigator.",
      "type": "boolean"
    },
    "orderable": {
      "description": "Whether the content of the field can be used to order lists.",
      "type": "boolean"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonTypeBean"
        }
      ],
      "description": "The data schema for the field."
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the field."
    },
    "searchable": {
      "description": "Whether the content of the field can be searched.",
      "type": "boolean"
    }
  },
  "type": "object",
  "xml": {
    "name": "field"
  }
}