Skip to content

Create Layout

connectcases_create_layout R Documentation

Creates a layout in the Cases domain

Description

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

  • Fields to display to the users

  • Field ordering

Title and Status fields cannot be part of layouts since they are not configurable.

Usage

connectcases_create_layout(domainId, name, content)

Arguments

domainId

[required] The unique identifier of the Cases domain.

name

[required] The name of the layout. It must be unique for the Cases domain.

content

[required] Information about which fields will be present in the layout, and information about the order of the fields.

Value

A list with the following syntax:

list(
  layoutId = "string",
  layoutArn = "string"
)

Request syntax

svc$create_layout(
  domainId = "string",
  name = "string",
  content = list(
    basic = list(
      topPanel = list(
        sections = list(
          list(
            fieldGroup = list(
              name = "string",
              fields = list(
                list(
                  id = "string"
                )
              )
            )
          )
        )
      ),
      moreInfo = list(
        sections = list(
          list(
            fieldGroup = list(
              name = "string",
              fields = list(
                list(
                  id = "string"
                )
              )
            )
          )
        )
      )
    )
  )
)