Skip to content

Update Template

connectcases_update_template R Documentation

Updates the attributes of an existing template

Description

Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Other template APIs are:

  • create_template

  • delete_template

  • get_template

  • list_templates

Usage

connectcases_update_template(domainId, templateId, name, description,
  layoutConfiguration, requiredFields, status, rules,
  tagPropagationConfigurations)

Arguments

domainId

[required] The unique identifier of the Cases domain.

templateId

[required] A unique identifier for the template.

name

The name of 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

An empty list.

Request syntax

svc$update_template(
  domainId = "string",
  templateId = "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"
      )
    )
  )
)