Function: createCommentWithAttachment()

function createCommentWithAttachment(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  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[];
  };
  comment?: {
   [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:320

This method creates a comment on a customer request using one or more attachment files (uploaded using servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile), with the visibility set by public. See

• GET servicedeskapi/request/{issueIdOrKey}/attachment
• GET servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment

Permissions required: Permission to add an attachment.

Request limitations: Customers can set public visibility only.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ additionalComment?: { body?: string; }; issueIdOrKey: string; public?: boolean; temporaryAttachmentIds?: string[]; }	-
parameters.additionalComment?	{ body?: string; }	-
parameters.additionalComment.body?	string	Content of the comment.
parameters.issueIdOrKey?	string	The ID or key of the customer request to which the attachment will be added.
parameters.public?	boolean	Controls whether the comment and its attachments are visible to customers
parameters.temporaryAttachmentIds?	string[]	List of IDs for the temporary attachments to be added to the customer request.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; 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[]; }; comment?: { [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; }; }; }>