jira.js
    Preparing search index...

    Function getTransitions

    • Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.

      Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.

      This operation can be accessed anonymously.

      Permissions required: A list or transition is returned only when the user has:

      However, if the user does not have the Transition issues project permission the response will not list any transitions.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (string & {} | "transitions.fields")[];
            includeUnavailableTransitions?: boolean;
            issueIdOrKey: string;
            skipRemoteOnlyCondition?: boolean;
            sortByOpsBarAndStatus?: boolean;
            transitionId?: string;
        }
        • Optionalexpand?: string | string[] | string & {} | (string & {} | "transitions.fields")[]

          Use expand to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in Transition issue.

        • OptionalincludeUnavailableTransitions?: boolean

          Whether details of transitions that fail a condition are included in the response

        • issueIdOrKey: string

          The ID or key of the issue.

        • OptionalskipRemoteOnlyCondition?: boolean

          Whether transitions with the condition Hide From User Condition are included in the response. Available to Connect and Forge app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.

        • OptionalsortByOpsBarAndStatus?: boolean

          Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.

        • OptionaltransitionId?: string

          The ID of the transition.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              expand?: string;
              transitions?: {
                  expand?: string;
                  fields?: Record<string, any>;
                  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?: {
                          project?: {
                              avatarUrls?: ...;
                              id?: ...;
                              key?: ...;
                              name?: ...;
                              projectCategory?: ...;
                              projectTypeKey?: ...;
                              self?: ...;
                              simplified?: ...;
                              [key: ...]: ...;
                          };
                          type?: (...) & (...)
                          | "PROJECT"
                          | "TEMPLATE";
                          [key: string]: unknown;
                      };
                      self?: string;
                      statusCategory?: {
                          colorName?: string;
                          id?: number;
                          key?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      untranslatedName?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility