jira.js
    Preparing search index...

    Function doTransition

    • Perform a transition on an issue. When performing the transition you can update or set other issue fields. The fields that can be set on transition, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource. If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted. The updateHistory param adds the issues retrieved by this method to the current user's issue history, if set to true (by default, the issue history does not include issues retrieved via the REST API). You can view the issue history in the Jira application, via the Issues dropdown or by using the lastViewed JQL field in an issue search.

      Parameters

      • client: Client
      • parameters: {
            fields?: Record<string, any>;
            historyMetadata?: {
                activityDescription?: string;
                activityDescriptionKey?: string;
                actor?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                    [key: string]: unknown;
                };
                cause?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                    [key: string]: unknown;
                };
                description?: string;
                descriptionKey?: string;
                emailDescription?: string;
                emailDescriptionKey?: string;
                extraData?: Record<string, string>;
                generator?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                    [key: string]: unknown;
                };
                type?: string;
                [key: string]: unknown;
            };
            issueIdOrKey: string;
            properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
            transition?: {
                description?: string;
                fields?: Record<
                    string,
                    {
                        allowedValues?: Record<string, any>[];
                        autoCompleteUrl?: string;
                        defaultValue?: Record<string, any>;
                        fieldId?: string;
                        hasDefaultValue?: boolean;
                        name?: string;
                        operations?: string[];
                        required?: boolean;
                        schema?: {
                            custom?: string;
                            customId?: number;
                            items?: string;
                            system?: string;
                            type?: string;
                            [key: string]: unknown;
                        };
                        [key: string]: unknown;
                    },
                >;
                id?: string;
                name?: string;
                opsbarSequence?: number;
                to?: {
                    description?: string;
                    iconUrl?: string;
                    id?: string;
                    name?: string;
                    self?: string;
                    statusCategory?: {
                        colorName?: string;
                        id?: number;
                        key?: string;
                        name?: string;
                        self?: string;
                        [key: string]: unknown;
                    };
                    statusColor?: string;
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            update?: Record<
                string,
                {
                    operation?: string;
                    value?: Record<string, any>;
                    [key: string]: unknown;
                }[],
            >;
        }
        • Optionalfields?: Record<string, any>
        • OptionalhistoryMetadata?: {
              activityDescription?: string;
              activityDescriptionKey?: string;
              actor?: {
                  avatarUrl?: string;
                  displayName?: string;
                  displayNameKey?: string;
                  id?: string;
                  type?: string;
                  url?: string;
                  [key: string]: unknown;
              };
              cause?: {
                  avatarUrl?: string;
                  displayName?: string;
                  displayNameKey?: string;
                  id?: string;
                  type?: string;
                  url?: string;
                  [key: string]: unknown;
              };
              description?: string;
              descriptionKey?: string;
              emailDescription?: string;
              emailDescriptionKey?: string;
              extraData?: Record<string, string>;
              generator?: {
                  avatarUrl?: string;
                  displayName?: string;
                  displayNameKey?: string;
                  id?: string;
                  type?: string;
                  url?: string;
                  [key: string]: unknown;
              };
              type?: string;
              [key: string]: unknown;
          }
        • issueIdOrKey: string

          Issue id or key

        • Optionalproperties?: { key?: string; value?: unknown; [key: string]: unknown }[]
        • Optionaltransition?: {
              description?: string;
              fields?: Record<
                  string,
                  {
                      allowedValues?: Record<string, any>[];
                      autoCompleteUrl?: string;
                      defaultValue?: Record<string, any>;
                      fieldId?: string;
                      hasDefaultValue?: boolean;
                      name?: string;
                      operations?: string[];
                      required?: boolean;
                      schema?: {
                          custom?: string;
                          customId?: number;
                          items?: string;
                          system?: string;
                          type?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  },
              >;
              id?: string;
              name?: string;
              opsbarSequence?: number;
              to?: {
                  description?: string;
                  iconUrl?: string;
                  id?: string;
                  name?: string;
                  self?: string;
                  statusCategory?: {
                      colorName?: string;
                      id?: number;
                      key?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  statusColor?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }
        • Optionalupdate?: Record<
              string,
              { operation?: string; value?: Record<string, any>; [key: string]: unknown }[],
          >
      • Optionaloptions: RequestOptions

      Returns Promise<void>

    Settings
    Member Visibility