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

GetTemplate

Returns the details for the requested template. Other template APIs are:

Request Syntax


POST /domains/domainId/templates/templateId HTTP/1.1

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

templateId

A unique identifier of a template.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdTime": "string",
   "deleted": boolean,
   "description": "string",
   "lastModifiedTime": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "templateArn": "string",
   "templateId": "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.

createdTime

Timestamp at which the resource was created.

Type: Timestamp

deleted

Denotes whether or not the resource has been deleted.

Type: Boolean

description

A brief description of the template.

Type: String

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

lastModifiedTime

Timestamp at which the resource was created or last modified.

Type: Timestamp

layoutConfiguration

Configuration of layouts associated to the template.

Type: LayoutConfiguration object

name

The name of the template.

Type: String

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

Pattern: .*[\S]

requiredFields

A list of fields that must contain a value for a case to be successfully created with this template.

Type: Array of RequiredField objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

rules

A list of case rules (also known as case field conditions) on a template.

Type: Array of TemplateRule objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

status

The status of the template.

Type: String

Valid Values: Active | Inactive

tags

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Type: String to string map

templateArn

The Amazon Resource Name (ARN) of the template.

Type: String

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

templateId

A unique identifier of a template.

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

InternalServerException

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

retryAfterSeconds: Advice to clients on when the call can be safely retried.

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.

resourceId: Unique identifier of the resource affected.
resourceType: Type of the resource affected.

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 GetTemplate.

{ }


{
  "templateId": "[template_id]",
  "templateArn": "[template_arn]",
  "name": "Shipping",
  "layoutConfiguration": {
  "defaultLayout": "[layout_id]"
    },
  "requiredFields": [
    {
    "fieldId": "[field_id]"
    }
  ]
  "description": "This is an example template for shipping issues",
  "status": "Inactive"
}