v2

OpenAPI 3.0.12026-08-0174115357.9 KB
Request

Get request comment by id

This method returns details of a customer request's comment.

Permissions required: Permission to view the customer request.

Response limitations: 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.

get/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}

Path parameters

issueIdOrKeystring required

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

commentIdinteger required

The ID of the comment to retrieve.

Query parameters

expandstring[]

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.

Response

Returns the comment.

_expandsstring[]

List of items that can be expanded in the response by specifying the expand query parameter.

bodystring

Content of the comment.

idstring

ID of the comment.

publicboolean

Indicates whether the comment is public (true) or private/internal (false).