Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/jira/src/serviceDesk/parameters/getRequestComments.ts>GetRequestComments

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface GetRequestComments
import { type GetRequestComments } from "https://deno.land/x/jira@v3.0.2/src/serviceDesk/parameters/getRequestComments.ts";

Properties

issueIdOrKey: string

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

optional
public: boolean

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

optional
internal: boolean

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

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

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
start: number

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

optional
limit: number

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