Skip to content

Update Layout

connectcases_update_layout R Documentation

Updates the attributes of an existing layout

Description

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A ValidationException is returned when you add non-existent fieldIds to a layout.

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

Usage

connectcases_update_layout(content, domainId, layoutId, name)

Arguments

content

Information about which fields will be present in the layout, the order of the fields.

domainId

[required] The unique identifier of the Cases domain.

layoutId

[required] The unique identifier of the layout.

name

The name of the layout. It must be unique per domain.

Value

An empty list.

Request syntax

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