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

CreateField

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

Request Syntax


POST /domains/domainId/fields HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainId

The unique identifier of the Cases domain.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description of the field.

Type: String

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

Required: No

name

The name of the field.

Type: String

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

Pattern: ^.*[\S]$

Required: Yes

type

Defines the data type, some system constraints, and default display of the field.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "fieldArn": "string",
   "fieldId": "string"
}

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.

fieldArn

The Amazon Resource Name (ARN) of the field.

Type: String

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

fieldId

The unique identifier of a field.

Type: String

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

HTTP Status Code: 409

InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

HTTP Status Code: 402

ThrottlingException

The rate has been exceeded for this API. Please try again after a few minutes.

HTTP Status Code: 429

ValidationException

The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400

Examples

Request and Response example

This example illustrates one usage of CreateField.


{
  "name": "Color",
  "type": "Text",
  "description": "The color of the item"
}


{
  "fieldArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id]",
  "fieldId": "[field_id]"
}