Skip to content

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.

Other template APIs are:

  • delete_template

  • get_template

  • list_templates

  • update_template

Usage

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

Arguments

domainId

[required] The unique identifier of the Cases domain.

name

[required] A name for the template. It must be unique per domain.

description

A brief description of the template.

layoutConfiguration

Configuration of layouts associated to the template.

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.

rules

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

tagPropagationConfigurations

Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.

Value

A list with the following syntax:

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

Request syntax

svc$create_template(
  domainId = "string",
  name = "string",
  description = "string",
  layoutConfiguration = list(
    defaultLayout = "string"
  ),
  requiredFields = list(
    list(
      fieldId = "string"
    )
  ),
  status = "Active"|"Inactive",
  rules = list(
    list(
      caseRuleId = "string",
      fieldId = "string"
    )
  ),
  tagPropagationConfigurations = list(
    list(
      resourceType = "Cases",
      tagMap = list(
        "string"
      )
    )
  )
)