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

CreateCaseComment

Adds a comment to an existing case.

Request Syntax


POST /v1/cases/caseId/create-comment HTTP/1.1
Content-type: application/json

{
   "body": "string",
   "clientToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

caseId

Required element used in combination with CreateCaseComment to specify a case ID.

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.

body

Required element used in combination with CreateCaseComment to add content for the new comment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12000.

Required: Yes

clientToken

Note

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "commentId": "string"
}

Response Elements

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

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

commentId

Response element indicating the new comment ID.

Type: String

Length Constraints: Fixed length of 6.

Pattern: \d{6}

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