Create Template

connectcases_create_template

R Documentation

Creates a template in the Cases domain¶

Description¶

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Usage¶

connectcases_create_template(description, domainId, layoutConfiguration,
  name, requiredFields, status)

Arguments¶

description: A brief description of the template.
domainId: [required] The unique identifier of the Cases domain.
layoutConfiguration: Configuration of layouts associated to the template.
name: [required] A name for the template. It must be unique per domain.
requiredFields: A list of fields that must contain a value for a case to be successfully created with this template.
status: The status of the template.

Value¶

A list with the following syntax:

list(
  templateArn = "string",
  templateId = "string"
)

Request syntax¶

svc$create_template(
  description = "string",
  domainId = "string",
  layoutConfiguration = list(
    defaultLayout = "string"
  ),
  name = "string",
  requiredFields = list(
    list(
      fieldId = "string"
    )
  ),
  status = "Active"|"Inactive"
)