Interface UiModificationContextDetails

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

interface UiModificationContextDetails {
    id?: string;
    isAvailable?: boolean;
    issueTypeId: null | string;
    portalId?: string;
    projectId: null | string;
    requestTypeId?: string;
    viewType:
        | null
        | "IssueTransition"
        | "GIC"
        | "IssueView"
        | "JSMRequestCreate";
}

Properties

id? isAvailable? issueTypeId portalId? projectId requestTypeId? viewType

Properties

Optionalid

id?: string

The ID of the UI modification context.

OptionalisAvailable

isAvailable?: boolean

Whether a context is available. For example, when a project is deleted the context becomes unavailable.

issueTypeId

issueTypeId: null | 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.

OptionalportalId

portalId?: string

The portal ID of the context. Only required for Jira Service Management request create portal view (JSMRequestCreate).

projectId

projectId: null | 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.

OptionalrequestTypeId

requestTypeId?: string

The request type ID of the context. Only required for Jira Service Management request create portal view (JSMRequestCreate).

viewType

viewType:
    | null
    | "IssueTransition"
    | "GIC"
    | "IssueView"
    | "JSMRequestCreate"

The view type of the context. Supported values:

  • GIC - Jira global issue create
  • IssueView - Jira issue view
  • IssueTransition - Jira issue transition
  • JSMRequestCreate - Jira Service Management request create portal view

For Jira view types (GIC, IssueView, IssueTransition), null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each Jira context can have a maximum of one wildcard.

Wildcards are not applicable for JSM contexts.

Settings

Member Visibility

On This Page

Properties