Details of an issue transition.

interface IssueTransition {
    expand?: string;
    fields?: {};
    hasScreen?: boolean;
    id?: string;
    isAvailable?: boolean;
    isConditional?: boolean;
    isGlobal?: boolean;
    isInitial?: boolean;
    looped?: boolean;
    name?: string;
    to?: {
        description?: string;
        iconUrl?: string;
        id?: string;
        name?: string;
        scope?: Agile.AgileModels.Scope;
        self?: string;
        statusCategory?: {
            colorName?: string;
            id?: number;
            key?: string;
            name?: string;
            self: string;
        };
    };
}

Properties

expand?: string

Expand options that include additional transition details in the response.

fields?: {}

Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.

Type declaration

    hasScreen?: boolean

    Whether there is a screen associated with the issue transition.

    id?: string

    The ID of the issue transition. Required when specifying a transition to undertake.

    isAvailable?: boolean

    Whether the transition is available to be performed.

    isConditional?: boolean

    Whether the issue has to meet criteria before the issue transition is applied.

    isGlobal?: boolean

    Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.

    isInitial?: boolean

    Whether this is the initial issue transition for the workflow.

    looped?: boolean
    name?: string

    The name of the issue transition.

    to?: {
        description?: string;
        iconUrl?: string;
        id?: string;
        name?: string;
        scope?: Agile.AgileModels.Scope;
        self?: string;
        statusCategory?: {
            colorName?: string;
            id?: number;
            key?: string;
            name?: string;
            self: string;
        };
    }

    A status.

    Type declaration

    • Optional description?: string

      The description of the status.

    • Optional iconUrl?: string

      The URL of the icon used to represent the status.

    • Optional id?: string

      The ID of the status.

    • Optional name?: string

      The name of the status.

    • Optional scope?: Agile.AgileModels.Scope

      The projects the item is associated with. Indicated for items associated with next-gen projects.

    • Optional self?: string

      The URL of the status.

    • Optional statusCategory?: {
          colorName?: string;
          id?: number;
          key?: string;
          name?: string;
          self: string;
      }

      A status category.

      • Optional colorName?: string

        The name of the color used to represent the status category.

      • Optional id?: number

        The ID of the status category.

      • Optional key?: string

        The key of the status category.

      • Optional name?: string

        The name of the status category.

      • self: string

        The URL of the status category.