REST API - Comment - Case Details

This table summarizes the REST API - Comment - case details.

Request

Format
POST <baseurl>/audit/comment/case/<classname>/majorversion>/<managedobjectid>
Path Parameters
  • classname: The fully qualified name of the case class. For example, com.example.gddemo.Car. You can obtain class names by using getCaseClassInfo.
  • majorversion: The version number of the case model. For example, 2 or 2.0.0.
  • managedobjectId: The case model ID. For example, 1.
Query Parameters parentid: (Optional): The audit ID returned in the CommentResponse element in response to a previous request.
Body comment element (required): This element (from the EventCollectorUpdateService schema defines the chart query.

Response

JSON Returns a JSON representation of the content of the CommentResponse element.
XML Returns the content of the CommentResponse element (from the EventCollectorUpdateService schema).

Example

Request
POST <baseurl>/audit/comment/case/com.example.xyzinsurance-1/1/1
Request Body
{
  "Comment": { "message": "This is a case object" }
}
Response
1686