Atlassian · Schema

Field

Details of a field.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
contextsCount	integer	Number of contexts where the field is used.
description	string	The description of the field.
id	string	The ID of the field.
isLocked	boolean	Whether the field is locked.
isUnscreenable	boolean	Whether the field is shown on screen or not.
key	string	The key of the field.
lastUsed	object
name	string	The name of the field.
projectsCount	integer	Number of projects where the field is used.
schema	object
screensCount	integer	Number of screens where the field is used.
searcherKey	string	The searcher key of the field. Returned for custom fields.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Field",
  "title": "Field",
  "additionalProperties": false,
  "description": "Details of a field.",
  "properties": {
    "contextsCount": {
      "description": "Number of contexts where the field is used.",
      "format": "int64",
      "type": "integer"
    },
    "description": {
      "description": "The description of the field.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the field.",
      "type": "string"
    },
    "isLocked": {
      "description": "Whether the field is locked.",
      "type": "boolean"
    },
    "isUnscreenable": {
      "description": "Whether the field is shown on screen or not.",
      "type": "boolean"
    },
    "key": {
      "description": "The key of the field.",
      "type": "string"
    },
    "lastUsed": {
      "$ref": "#/components/schemas/FieldLastUsed"
    },
    "name": {
      "description": "The name of the field.",
      "type": "string"
    },
    "projectsCount": {
      "description": "Number of projects where the field is used.",
      "format": "int64",
      "type": "integer"
    },
    "schema": {
      "$ref": "#/components/schemas/JsonTypeBean"
    },
    "screensCount": {
      "description": "Number of screens where the field is used.",
      "format": "int64",
      "type": "integer"
    },
    "searcherKey": {
      "description": "The searcher key of the field. Returned for custom fields.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "schema"
  ],
  "type": "object"
}