Function: getRequestCommentById()
function getRequestCommentById(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
_links?: {
[key: string]: unknown;
self?: string;
};
author?: {
[key: string]: unknown;
_links?: {
[key: string]: unknown;
avatarUrls?: Record<string, any>;
jiraRest?: string;
self?: 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;
}>;Defined in: src/serviceDeskServer/api/customerRequests.ts:91
Returns a specific comment of a specific customer request based on the provided comment ID.
Permissions:
The calling user must have permission to view the comment. For example, 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
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { commentId: string; issueIdOrKey: string; } | - |
parameters.commentId | string | ID of the comment to retrieve. |
parameters.issueIdOrKey? | string | The id or key of the customer request. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; author?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, any>; jiraRest?: string; self?: 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; }>