Interface GetRequestComments

interface GetRequestComments {
    expand?: string | string[] | ("attachment" | "renderedBody")[];
    internal?: boolean;
    issueIdOrKey: string;
    limit?: number;
    public?: boolean;
    start?: number;
}

Properties

expand? internal? issueIdOrKey limit? public? start?

Properties

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 each 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) for each comment.

Optional internal

internal?: boolean

Specifies whether to return internal comments or not. Default: true.

issueIdOrKey

issueIdOrKey: string

The ID or key of the customer request whose comments will be retrieved.

Optional limit

limit?: number

The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.

Optional public

public?: boolean

Specifies whether to return public comments or not. Default: true.

Optional start

start?: number

The starting index of the returned comments. Base index: 0. See the Pagination section for more details.

Settings

Member Visibility

Theme

On This Page

expandinternalissueIdOrKeylimitpublicstart