Records | User Interface API Developer Guide

Get Record Data and Object Metadata
Get layout information, metadata, and data to build UI for a single record or for a collection of records.

Get Record Layout Metadata
Get metadata about page layouts for the specified object type.

Get a Directory of Supported Objects
Get a directory of objects that are supported by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.

Get Object Metadata
Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.

Get Values for a Picklist Field
If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.

Get Values for All Picklist Fields of a Record Type
Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.

Get Child Records
Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record.

Get a Record
Get a record’s data.

Get a Batch of Records
Get data for a batch of records.

Create a Record
Create a record. First, make a request to the Clone Record Default or Create Record Default resources to get the default metadata and data for the record.

Get Default Values to Clone a Record
Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.

Get Default Values to Create a Record
Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.

Update a Record
Update a record's data.

Delete a Record
Delete a record.

Get Lookup Field Suggestions
When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.

Get Lookup Field Suggestions for a Specified Object
When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.