jira.js
    Preparing search index...

    Function editIssue

    • Edits an issue from a JSON representation. The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value.

      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;
            notifyUsers?: 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

        • OptionalnotifyUsers?: string

          Send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.

        • 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>