Atlassian · Schema

UiModificationContextDetails

The details of a UI modification's context, which define where to activate the UI modification.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id string The ID of the UI modification context.
isAvailable boolean Whether a context is available. For example, when a project is deleted the context becomes unavailable.
issueTypeId string The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard.
projectId string The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard.
viewType string The view type of the context. Only `GIC`(Global Issue Create) and `IssueView` are supported. Null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each UI modif
View JSON Schema on GitHub

JSON Schema

atlassian-uimodificationcontextdetails-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UiModificationContextDetails",
  "title": "UiModificationContextDetails",
  "additionalProperties": false,
  "description": "The details of a UI modification's context, which define where to activate the UI modification.",
  "properties": {
    "id": {
      "description": "The ID of the UI modification context.",
      "readOnly": true,
      "type": "string"
    },
    "isAvailable": {
      "description": "Whether a context is available. For example, when a project is deleted the context becomes unavailable.",
      "readOnly": true,
      "type": "boolean"
    },
    "issueTypeId": {
      "description": "The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard.",
      "type": "string"
    },
    "projectId": {
      "description": "The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard.",
      "type": "string"
    },
    "viewType": {
      "description": "The view type of the context. Only `GIC`(Global Issue Create) and `IssueView` are supported. Null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each UI modification context can have a maximum of one wildcard.",
      "enum": [
        "GIC",
        "IssueView"
      ],
      "type": "string"
    }
  },
  "type": "object",
  "writeOnly": true
}