Skip to content

Function: createRequestComment() ​

ts
function createRequestComment(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  attachments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  author?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<string, string>;
        jiraRest?: string;
        self?: string;
     };
     accountId?: string;
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  body?: string;
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  public?: boolean;
  renderedBody?: {
   [key: string]: unknown;
     html?: string;
  };
}>;

Defined in: src/serviceDesk/api/request.ts:438

This method creates a public or private (internal) comment on a customer request, with the comment visibility set by public. The user recorded as the author of the comment.

Permissions required: User has Add Comments permission.

Request limitations: Customers can set comments to public visibility only.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body?: string; issueIdOrKey: string; public?: boolean; }-
parameters.body?stringContent of the comment.
parameters.issueIdOrKey?stringThe ID or key of the customer request to which the comment will be added.
parameters.public?booleanIndicates whether the comment is public (true) or private/internal (false).
options?RequestOptions-

Returns ​

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