Interface GetRequestCommentById

interface GetRequestCommentById {
    commentId: number;
    expand?: string | string[] | ("attachment" | "renderedBody")[];
    issueIdOrKey: string;
}

Properties

commentId expand? issueIdOrKey

Properties

commentId

commentId: number

The ID of the comment to retrieve.

Optional expand

expand?: string | string[] | ("attachment" | "renderedBody")[]

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

issueIdOrKey: string

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

Settings

Member Visibility

Theme

On This Page

commentIdexpandissueIdOrKey