Atlassian · Schema

IssueUpdateDetails

Details of an issue update request.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
fields	object	List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields
historyMetadata	object	Additional issue history details.
properties	array	Details of issue properties to be add or update.
transition	object	Details of a transition. Required when performing a transition, optional when creating or editing an issue.
update	object	A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IssueUpdateDetails",
  "title": "IssueUpdateDetails",
  "additionalProperties": true,
  "description": "Details of an issue update request.",
  "properties": {
    "fields": {
      "additionalProperties": {},
      "description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.",
      "type": "object"
    },
    "historyMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadata"
        }
      ],
      "description": "Additional issue history details."
    },
    "properties": {
      "description": "Details of issue properties to be add or update.",
      "items": {
        "$ref": "#/components/schemas/EntityProperty"
      },
      "type": "array"
    },
    "transition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueTransition"
        }
      ],
      "description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue."
    },
    "update": {
      "additionalProperties": {
        "items": {
          "$ref": "#/components/schemas/FieldUpdateOperation"
        },
        "type": "array"
      },
      "description": "A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.",
      "type": "object"
    }
  },
  "type": "object"
}