Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListComments

Returns comments for a designated case.

Request Syntax


POST /v1/cases/caseId/list-comments HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

caseId

Required element for ListComments to designate the case to query.

Length Constraints: Minimum length of 10. Maximum length of 32.

Pattern: \d{10,32}.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

Optional element for ListComments to limit the number of responses.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

nextToken

An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2000.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "body": "string",
         "commentId": "string",
         "createdDate": number,
         "creator": "string",
         "lastUpdatedBy": "string",
         "lastUpdatedDate": number
      }
   ],
   "nextToken": "string",
   "total": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

Response element for ListComments providing the body, commentID, createDate, creator, lastUpdatedBy and lastUpdatedDate for each response.

Type: Array of ListCommentsItem objects

nextToken

An optional string that, if supplied on subsequent calls to ListComments, allows the API to fetch the next page of results.

Type: String

total

Response element for ListComments identifying the number of responses.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

message: The ID of the resource which lead to the access denial.

HTTP Status Code: 403

ConflictException

message: The exception message.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

message: The exception message.
retryAfterSeconds: The number of seconds after which to retry the request.

HTTP Status Code: 500

InvalidTokenException

message: The exception message.

HTTP Status Code: 423

ResourceNotFoundException

message: The exception message.

HTTP Status Code: 404

SecurityIncidentResponseNotActiveException

message: The exception message.

HTTP Status Code: 400

ServiceQuotaExceededException

message: The exception message.
quotaCode: The code of the quota.
resourceId: The ID of the requested resource which lead to the service quota exception.
resourceType: The type of the requested resource which lead to the service quota exception.
serviceCode: The service code of the quota.

HTTP Status Code: 402

ThrottlingException

message: The exception message.
quotaCode: The quota code of the exception.
retryAfterSeconds: The number of seconds after which to retry the request.
serviceCode: The service code of the exception.

HTTP Status Code: 429

ValidationException

fieldList: The fields which lead to the exception.
message: The exception message.
reason: The reason for the exception.

HTTP Status Code: 400