Interface GetComments

interface GetComments {
    expand?: string;
    issueIdOrKey: string;
    maxResults?: number;
    orderBy?: string;
    startAt?: number;
}

Properties

expand? issueIdOrKey maxResults? orderBy? startAt?

Properties

Optional expand

expand?: string

Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

issueIdOrKey

issueIdOrKey: string

The ID or key of the issue.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional orderBy

orderBy?: string

Order the results by a field. Accepts created to sort comments by their created date.

Optional startAt

startAt?: number

The index of the first item to return in a page of results (page offset).

Settings

Member Visibility

Theme

On This Page

expandissueIdOrKeymaxResultsorderBystartAt