Layouts

Models

# Layout Model

object "layout"
The description of the model.

id string
The unique ID of the layout prefixed with lay_

parent_id string
The unique ID of the parent layout, prefixed with lay_. This property is used to establish a hierarchical relationship between layouts.

root_id string
The unique ID of the root layout, prefixed with lay_. This property is used to establish the top-level layout in a hierarchy of nested layouts.

name string
The name of the layout. This property is required and must be between 1 and 127 characters in length.

nested_name string
The name of the layout when it is nested inside a parent layout. This property must be between 1 and 127 characters in length.

location_id string
The unique ID of the location to which this layout belongs. This property is required and must be a valid location ID.

organization_id string
Unique identifier for the organization that owns this layout.

code string
A code that can be assigned to layouts within a location. The layout code must be unique for a given location, but two different locations can have the same code.

path string
The path that represents the layout's location in the hierarchy. This property can be used to define the layout's position within a nested structure.

checksum string
A hash value computed from the current layout configuration that enables verification of data integrity. This value gets updated whenever the layout changes.

metadata object
Key value pairs of data that you can set for this layout.

created_at integer
Time in epoch seconds when this resource was created.

updated_at integer
Time in epoch seconds when this resource was last updated.

updated_by string
The ID of the user or key who last updated the layout.