User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Record Input
User Interface API Response Bodies
PDF

Newer Version Available

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

Page Reference Input

To add a navigation item, include a pageReference. A pageReference is a JSON object that describes the navigation item’s page type, its attributes, and the state of the page.
Example

The request body contains the list of navigation items in the order they should appear. To add a navigation item, include a pageReference describing the item.

Properties
Name Type Description Required or Optional Available Version
type String The page reference type generates a unique URL format and defines attributes that apply to all pages of that type. See PageReference Types. Required 47.0
attributes Map<String, Object> Map of values for each attribute specified by the page definition, for example, objectAPIName or actionName. Required 47.0
state Map<String, Object> Map of conditional values that customize content on the page, such as filterName. Optional 47.0