Newer Version Available

This content describes an older version of this product. View Latest

Record Layout

The layout information for a record.
Property Name Type Description Filter Group and Version Available Version
id String The layout ID. Small, 41.0 41.0
layoutType String The layout type for the record. One of these values:
  • Compact—Use this value to get a layout that contains a record’s key fields.
  • Full—(Default) Use this value to get a full layout.
Small, 41.0 41.0
mode String The access mode for the record. This value determines which fields to get from a layout. Layouts have different fields for create, edit, and view modes. For example, formula fields are rendered in view mode, but not in create mode because they’re calculated at run time, like formulas in a spreadsheet. One of these values:
  • Create—Use this mode if you intend to build UI that lets a user create a record. This mode is used by the /ui-api/record-defaults/create/{apiName} resource.
  • Edit—Use this mode if you intend to build UI that lets a user edit a record. This mode is used by the /ui-api/record-defaults/clone/{recordId} resource.
  • View—(Default) Use this mode if you intend to build UI that displays a record.
Small, 41.0 41.0
objectApiName String The API name of the object that the layout is associated with. Small, 49.0 49.0
recordTypeId String The record type ID for this record. Small, 49.0 49.0
saveOptions Record Layout Save Option[] The save options for the layout. Small, 51.0 51.0
sections Record Layout Section[] A collection of layout sections. Small, 41.0 41.0