ConnectCases / Client / update_layout

update_layout¶

ConnectCases.Client.update_layout(**kwargs)¶

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.

Note

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

Request Syntax

response = client.update_layout(
    domainId='string',
    layoutId='string',
    name='string',
    content={
        'basic': {
            'topPanel': {
                'sections': [
                    {
                        'fieldGroup': {
                            'name': 'string',
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ]
                        }
                    },
                ]
            },
            'moreInfo': {
                'sections': [
                    {
                        'fieldGroup': {
                            'name': 'string',
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ]
                        }
                    },
                ]
            }
        }
    }
)

Parameters:

domainId (string) –
[REQUIRED]

The unique identifier of the Cases domain.
layoutId (string) –
[REQUIRED]

The unique identifier of the layout.
name (string) – The name of the layout. It must be unique per domain.
content (dict) –
Information about which fields will be present in the layout, the order of the fields.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: basic.
- basic (dict) –
  
  Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.
  - topPanel (dict) –
    
    This represents sections in a panel of the page layout.
    - sections (list) –
      
      Ordered list containing different kinds of sections that can be added.
      - (dict) –
        
        This represents a sections within a panel or tab of the page layout.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: fieldGroup.
        
        fieldGroup (dict) –
        
        Consists of a group of fields and associated properties.
        
        name (string) –
        
        Name of the field group.
        
        fields (list) – [REQUIRED]
        
        Represents an ordered list containing field related information.
        
        (dict) –
        
        Object for field related information.
        
        id (string) – [REQUIRED]
        
        Unique identifier of a field.
  - moreInfo (dict) –
    
    This represents sections in a tab of the page layout.
    - sections (list) –
      
      Ordered list containing different kinds of sections that can be added.
      - (dict) –
        
        This represents a sections within a panel or tab of the page layout.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: fieldGroup.
        
        fieldGroup (dict) –
        
        Consists of a group of fields and associated properties.
        
        name (string) –
        
        Name of the field group.
        
        fields (list) – [REQUIRED]
        
        Represents an ordered list containing field related information.
        
        (dict) –
        
        Object for field related information.
        
        id (string) – [REQUIRED]
        
        Unique identifier of a field.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

ConnectCases.Client.exceptions.InternalServerException
ConnectCases.Client.exceptions.ResourceNotFoundException
ConnectCases.Client.exceptions.ValidationException
ConnectCases.Client.exceptions.ThrottlingException
ConnectCases.Client.exceptions.AccessDeniedException
ConnectCases.Client.exceptions.ConflictException
ConnectCases.Client.exceptions.ServiceQuotaExceededException