jira.js
    Preparing search index...

    Function getChangeLogs

    • Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest.

      This operation can be accessed anonymously.

      Permissions required:

      Parameters

      • client: Client
      • parameters: { issueIdOrKey: string; maxResults?: number; startAt?: number }
        • issueIdOrKey: string

          The ID or key of the issue.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  author?: {
                      accountId?: string;
                      accountType?: string;
                      active?: boolean;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  created?: Date;
                  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, any>;
                      generator?: {
                          avatarUrl?: string;
                          displayName?: string;
                          displayNameKey?: string;
                          id?: string;
                          type?: string;
                          url?: string;
                          [key: string]: unknown;
                      };
                      type?: string;
                      [key: string]: unknown;
                  };
                  id?: string;
                  items?: {
                      field?: string;
                      fieldId?: string;
                      fieldtype?: string;
                      from?: string
                      | null;
                      fromString?: string | null;
                      to?: string | null;
                      toString?: string | null;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility