User Interface API Developer Guide

Get Started with User Interface API
User Interface API Resources
Record UI, Get
Record Layout, Get
Object Info, Get
Records, Get, Delete, Patch
Records, Batch Get
Records, Post
Clone Record Defaults, Get
Create Record Defaults, Get
Picklist Values, Get
User Interface API Request Bodies
User Interface API Response Bodies
PDF

Newer Version Available

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

Create Record Defaults, Get

Get the default layout information and object information for creating a record. After getting the default values, make a request to POST /ui-api/records to create the record.

The response contains the default field values for a new record of the object type specified in {apiName}. It also contains the corresponding layout for Create mode, and object metadata.

Resource
1/ui-api/record-defaults/create/{apiName}
Available version
39.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
formFactor String The layout display size for the record. One of these values:
  • Large—(Default) Use this value to get a layout for desktop display size.
  • Medium—Use this value to get a layout for tablet display size.
  • Small—Use this value to get a layout for phone display size.
 Optional 39.0
recordTypeId Id The ID of the record type (RecordType object) for the new record. If not provided, the default record type is used. Optional 39.0
Response body for GET
Record Defaults