jira.js
    Preparing search index...

    Function getCommentsByIds

    • Returns a paginated list of comments specified by a list of comment IDs.

      This operation can be accessed anonymously.

      Permissions required: Comments are returned where the user:

      • Has Browse projects project permission for the project containing the comment.
      • If issue-level security is configured, issue-level security permission to view the issue.
      • If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | ("properties" | string & {} | "renderedBody")[];
            ids: number[];
        }
        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | ("properties" | string & {} | "renderedBody")[]

          Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:

          • renderedBody Returns the comment body rendered in HTML.
          • properties Returns the comment's properties.
        • ids: number[]

          The list of comment IDs. A maximum of 1000 IDs can be specified.

      • 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;
                  };
                  body?: {
                      content: Record<string, any>[];
                      type: string & {} | "doc";
                      version: number;
                      [key: string]: unknown;
                  };
                  created?: Date;
                  id?: string;
                  jsdAuthorCanSeeRequest?: boolean;
                  jsdPublic?: boolean;
                  properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
                  renderedBody?: string;
                  self?: string;
                  updateAuthor?: {
                      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;
                  };
                  updated?: Date;
                  visibility?: {
                      identifier?: string
                      | null;
                      type?: "role" | "group" | string & {};
                      value?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility