jira.js
    Preparing search index...

    Function getRequestCommentById

    • This method returns details of a customer request's comment.

      Permissions required: Permission to view the customer request.

      Response limitations: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

      Parameters

      • client: Client
      • parameters: { commentId: number; expand?: string[]; issueIdOrKey: string }
        • commentId: number

          The ID of the comment to retrieve.

        • Optionalexpand?: string[]

          A multi-value parameter indicating which properties of the comment to expand:

          • attachment returns the attachment details, if any, for the comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.)
          • renderedBody (Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment.
        • issueIdOrKey: string

          The ID or key of the customer request that contains the comment.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              _expands?: string[];
              _links?: { self?: string; [key: string]: unknown };
              attachments?: {
                  _expands?: string[];
                  _links?: {
                      base?: string;
                      context?: string;
                      next?: string;
                      prev?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  isLastPage?: boolean;
                  limit?: number;
                  size?: number;
                  start?: number;
                  values?: {
                      _links?: {
                          content?: string;
                          jiraRest?: string;
                          self?: string;
                          thumbnail?: string;
                          [key: string]: unknown;
                      };
                      author?: {
                          _links?: {
                              avatarUrls?: ...;
                              jiraRest?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          accountId?: string;
                          active?: boolean;
                          displayName?: string;
                          emailAddress?: string;
                          key?: string;
                          name?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      created?: {
                          epochMillis?: number;
                          friendly?: string;
                          iso8601?: string;
                          jira?: string;
                          [key: string]: unknown;
                      };
                      filename?: string;
                      mimeType?: string;
                      size?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              author?: {
                  _links?: {
                      avatarUrls?: Record<string, any>;
                      jiraRest?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  accountId?: string;
                  active?: boolean;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              body?: string;
              created?: {
                  epochMillis?: number;
                  friendly?: string;
                  iso8601?: string;
                  jira?: string;
                  [key: string]: unknown;
              };
              id?: string;
              public?: boolean;
              renderedBody?: { html?: string; [key: string]: unknown };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility