Atlassian · Schema

FieldCreateMetadata

The metadata describing an issue field for createmeta.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
allowedValues	array	The list of values allowed in the field.
autoCompleteUrl	string	The URL that can be used to automatically complete the field.
configuration	object	The configuration properties.
defaultValue	object	The default value of the field.
fieldId	string	The field id.
hasDefaultValue	boolean	Whether the field has a default value.
key	string	The key of the field.
name	string	The name of the field.
operations	array	The list of operations that can be performed on the field.
required	boolean	Whether the field is required.
schema	object	The data type of the field.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FieldCreateMetadata",
  "title": "FieldCreateMetadata",
  "additionalProperties": false,
  "description": "The metadata describing an issue field for createmeta.",
  "properties": {
    "allowedValues": {
      "description": "The list of values allowed in the field.",
      "items": {
        "readOnly": true
      },
      "readOnly": true,
      "type": "array"
    },
    "autoCompleteUrl": {
      "description": "The URL that can be used to automatically complete the field.",
      "readOnly": true,
      "type": "string"
    },
    "configuration": {
      "additionalProperties": {
        "readOnly": true
      },
      "description": "The configuration properties.",
      "readOnly": true,
      "type": "object"
    },
    "defaultValue": {
      "description": "The default value of the field.",
      "readOnly": true
    },
    "fieldId": {
      "description": "The field id.",
      "readOnly": true,
      "type": "string"
    },
    "hasDefaultValue": {
      "description": "Whether the field has a default value.",
      "readOnly": true,
      "type": "boolean"
    },
    "key": {
      "description": "The key of the field.",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "The name of the field.",
      "readOnly": true,
      "type": "string"
    },
    "operations": {
      "description": "The list of operations that can be performed on the field.",
      "items": {
        "readOnly": true,
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "required": {
      "description": "Whether the field is required.",
      "readOnly": true,
      "type": "boolean"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonTypeBean"
        }
      ],
      "description": "The data type of the field.",
      "readOnly": true
    }
  },
  "required": [
    "fieldId",
    "key",
    "name",
    "operations",
    "required",
    "schema"
  ],
  "type": "object",
  "xml": {
    "name": "availableField"
  }
}