pageReference Types

Lightning Component Type

A Lightning component that implements the lightning:isUrlAddressable interface, which enables the component to be navigated directly via URL.

Type

1standard__component

Type Attributes

Property	Type	Description	Required?
componentName	String	The Lightning component name in the format namespace__componentName.	Y

Example

1{    
2    "type": "standard__component",
3    "attributes": {
4        "componentName": "c__MyLightningComponent"    
5    },    
6    "state": {
7        "myAttr": "attrValue"    
8    }
9}

URL Format

1/cmp/{componentName}?myAttr=attrValue

Knowledge Article Page Type

A page that interacts with a Knowledge Article record.

Type

1standard__knowledgeArticlePage

Type Attributes

Property	Type	Description	Required?
articleType	String	The ArticleType API name of the Knowledge Article record.	Y
urlName	String	The URL of the Knowledge Article record.	Y

Example

1{    
2    "type": "standard__knowledgeArticlePage",
3    "attributes": {
4        "articleType": "Briefings",
5        "urlName": "February-2017"
6    }
7}

URL Format

1/articles/{articleType}/{urlName}

Named Page Type

A standard page with a unique name. Only home, chatter, today, and dataAssessment are supported.

Type

1standard__namedPage

Type Attributes

Property	Type	Description	Required?
pageName	String	The unique name of the page.	Y

Example

1{    
2    "type": "standard__namedPage",
3    "attributes": {
4        "pageName": "home"    
5    }
6}

URL Format

1/page/{pageName}

Navigation Item Page Type

A page that displays the content mapped to a CustomTab. Visualforce tabs, Web tabs, Lightning Pages, and Lightning Component tabs are supported.

Type

1standard__navItemPage

Type Attributes

Property	Type	Description	Required?
apiName	String	The unique name of the CustomTab.	Y

Example

1{    
2    "type": "standard__navItemPage",
3    "attributes": {
4        "apiName": "MyCustomTabName"    
5    }
6}

URL Format

1/n/{devName}

Object Page Type

Type

1standard__objectPage

Type Attributes

Property	Type	Description	Required?
actionName	String	The action name to invoke. Valid values include home, list, and new.	Y
objectApiName	String	The API name of the object.	Y

Example

1{    
2    "type": "standard__objectPage",
3    "attributes": {
4        "objectApiName": "Case",
5        "actionName": "home"
6    }
7}

1{
2    type: "standard__objectPage",
3    attributes: {
4        objectApiName: "Account",
5        actionName: "list"
6    },
7    state: {
8        filterName: "Recent"
9    }
10}

URL Format

1/r/{objectApiName}/{actionName}
2/r/{objectApiName}/{actionName}?filterName=Recent

Record Page Type

A page that interacts with a record in the org and supports standard actions for that record.

Type

1standard__recordPage

Type Attributes

Property	Type	Description	Required?
actionName	String	The action name to invoke. Valid values include clone, edit, and view.	Y
objectApiName	String	The API name of the record’s object. Optional for lookups.
recordId	String	The 18 character record ID.	Y

Example

1{    
2       "type": "standard__recordPage",
3       "attributes": {
4           "recordId": "001xx000003DGg0AAG",
5           "objectApiName": "PersonAccount",
6           "actionName": "view"
7       }
8}

URL Format

1/r/{objectApiName}/{recordId}/{actionName}
2/r/{recordId}/{actionName}

Record Relationship Page Type

A page that interacts with a relationship on a particular record in the org. Only related lists are supported.

Type

1standard__recordRelationshipPage

Type Attributes

Property	Type	Description	Required?
actionName	String	The action name to invoke. Only view is supported.	Y
objectApiName	String	The API name of the object that defines the relationship. Optional for lookups.
recordId	String	The 18 character record ID of the record that defines the relationship.	Y
relationshipApiName	String	The API name of the object’s relationship field

Example

1{    
2    "type": "standard__recordRelationshipPage",
3    "attributes": {
4        "recordId": "500xx000000Ykt4AAC",
5        "objectApiName": "Case",
6        "relationshipApiName": "CaseComments",
7        "actionName": "view"
8    }
9}

URL Format

1/r/{objectApiName}/{recordId}/related/{relationshipApiName}/{actionName}
2/r/{recordId}/related/{relationshipApiName}/{actionName}