Returns the description for the list of fields in the request parameters.
Request Syntax
POST /domains/domainId/fields-batch HTTP/1.1
Content-type: application/json
{
"fields": [
{
"id": "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.
- fields
-
A list of unique field identifiers.
Type: Array of FieldIdentifier objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"errors": [
{
"errorCode": "string",
"id": "string",
"message": "string"
}
],
"fields": [
{
"createdTime": "string",
"deleted": boolean,
"description": "string",
"fieldArn": "string",
"fieldId": "string",
"lastModifiedTime": "string",
"name": "string",
"namespace": "string",
"tags": {
"string" : "string"
},
"type": "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.
- errors
-
A list of field errors.
Type: Array of FieldError objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- fields
-
A list of detailed field information.
Type: Array of GetFieldResponse objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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
- 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
- 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 BatchGetField.
{
"fields":[
{
"id":"[field_id_1]"
},
{
"id":"[field_id_2]"
},
{
"id":"case_id"
}
]
} {
"errors":[
],
"fields":[
{
"description":"Test with description",
"fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_1]",
"fieldId":"[field_id_1]",
"name":"field1",
"namespace":"Custom",
"tags":{
"resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/5a17045a-9150-48f9-8cd5-8a5946585b73"
},
"type":"SingleSelect"
},
{
"description":"Unique Identifier of the case",
"fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/case_id",
"fieldId":"case_id",
"name":"Case Id",
"namespace":"System",
"tags":{
"resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/case_id"
},
"type":"Text"
},
{
"description":"test",
"fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_2]",
"fieldId":"[field_id_2]",
"name":"field2",
"namespace":"Custom",
"tags":{
"resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_2]"
},
"type":"SingleSelect"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
