User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Top-Level Response Bodies
User Interface API Nested Response Bodies
Advanced Lookup Display Info
Advanced Lookup Display Info Field
Advanced Lookup Info
Batch Result Item
Canvas Layout Component
Case Status Picklist Value Attributes
Child Relationship
Custom Link Layout Component
Display Layout
Display Layout and Matching Info
Duplicate Record Error
Duplicate Result Info
Duplicate Rule
Duplicate Rule Filter
Duplicate Rule Filter Item
Error Message
Error with Output
Field
Field Layout Component
Field Value
Filtered Lookup Info
Lead Status Picklist Value Attributes
List Column
List Column Inline Edit Attributes
List Filter by Info
List Info Share
List Info Share Category
List Info Summary
List Inline Edit Details
List Object Column
List Object Picklist Value
List Object Quick Filter Overrides
List Object Scope
List Object Scope Available Entity
List Order By Info
List Reference
List Scope
List Scope Entity
List Scope Related Entity
List User Preference
Location Field
Lookup Metadata
Lookup Metadata Target Info
Match
Match Result
Match Result Info
Match Rule
Matching Info
Navigation Item
Object Action
Object Info Directory Entry
Opportunity Stage Picklist Value Attributes
Page Reference
Picklist Value
Platform Action
Record Exceptions
Record Exception Error
Record Layout Component
Record Layout Item
Record Layout Row
Record Layout Save Option
Record Layout Section
Record Layout Section User State
Record Layout User State
Record Template Clone
Record Template Create
Record Type Info
Reference To Info
Related List Column
Related List Info Summary
Related List Reference
Report Layout Component
Theme Banner
Theme Image
Theme Info
Visualforce Layout Component
Work Step Status Picklist Value Attributes
User Interface API Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Custom Link Layout Component

A custom link component on a record page layout.
Property Name Type Description Filter Group and Version Available Version
apiName String If a field powers this component, this property contains the API name of the field. Small, 41.0 41.0
behavior String Indicates how a link behaves on open. One of these values:
  • NewWindow—Open a new window.
  • NoSidebar—No sidebar
  • OnClickJavaScript—When the link is clicked, run JavaScript.
  • Replace—Replace the current page.
  • Sidebar—Sidebar
 Small, 41.0 41.0
componentType String The component type. The value is CustomLink. Small, 41.0 41.0
customLinkUrl String The custom link URL. Small, 41.0 41.0
label String The custom link label. Small, 41.0 41.0