Atlassian · Schema

IssueBean

Details about an issue.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
changelog object Details of changelogs associated with the issue.
editmeta object The metadata for the fields on the issue that can be amended.
expand string Expand options that include additional issue details in the response.
fields object
fieldsToInclude object
id string The ID of the issue.
key string The key of the issue.
names object The ID and name of each field present on the issue.
operations object The operations that can be performed on the issue.
properties object Details of the issue properties identified in the request.
renderedFields object The rendered value of each field present on the issue.
schema object The schema describing each field present on the issue.
self string The URL of the issue details.
transitions array The transitions that can be performed on the issue.
versionedRepresentations object The versions of each field on the issue.
View JSON Schema on GitHub

JSON Schema

atlassian-issuebean-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IssueBean",
  "title": "IssueBean",
  "additionalProperties": false,
  "description": "Details about an issue.",
  "properties": {
    "changelog": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageOfChangelogs"
        }
      ],
      "description": "Details of changelogs associated with the issue.",
      "readOnly": true
    },
    "editmeta": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueUpdateMetadata"
        }
      ],
      "description": "The metadata for the fields on the issue that can be amended.",
      "readOnly": true
    },
    "expand": {
      "description": "Expand options that include additional issue details in the response.",
      "readOnly": true,
      "type": "string",
      "xml": {
        "attribute": true
      }
    },
    "fields": {
      "additionalProperties": {},
      "type": "object"
    },
    "fieldsToInclude": {
      "$ref": "#/components/schemas/IncludedFields"
    },
    "id": {
      "description": "The ID of the issue.",
      "readOnly": true,
      "type": "string"
    },
    "key": {
      "description": "The key of the issue.",
      "readOnly": true,
      "type": "string"
    },
    "names": {
      "additionalProperties": {
        "readOnly": true,
        "type": "string"
      },
      "description": "The ID and name of each field present on the issue.",
      "readOnly": true,
      "type": "object"
    },
    "operations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Operations"
        }
      ],
      "description": "The operations that can be performed on the issue.",
      "readOnly": true
    },
    "properties": {
      "additionalProperties": {
        "readOnly": true
      },
      "description": "Details of the issue properties identified in the request.",
      "readOnly": true,
      "type": "object"
    },
    "renderedFields": {
      "additionalProperties": {
        "readOnly": true
      },
      "description": "The rendered value of each field present on the issue.",
      "readOnly": true,
      "type": "object"
    },
    "schema": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonTypeBean"
      },
      "description": "The schema describing each field present on the issue.",
      "readOnly": true,
      "type": "object"
    },
    "self": {
      "description": "The URL of the issue details.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "transitions": {
      "description": "The transitions that can be performed on the issue.",
      "items": {
        "$ref": "#/components/schemas/IssueTransition"
      },
      "readOnly": true,
      "type": "array"
    },
    "versionedRepresentations": {
      "additionalProperties": {
        "additionalProperties": {
          "readOnly": true
        },
        "readOnly": true,
        "type": "object"
      },
      "description": "The versions of each field on the issue.",
      "readOnly": true,
      "type": "object"
    }
  },
  "type": "object",
  "xml": {
    "name": "issue"
  }
}