Pagelink
Class: metadata
Represents a page link that navigates users to custom URL or Custom Page destinations.
Learn about Page Links in Vault Help.
| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Required Max length: 40 | UI-friendly string in the Vault's base language. |
active | Type: Boolean | Indicates whether the component is active. |
description | Type: String Max length: 255 | A general description of the page link. |
url | Type: String Required Max length: 1500 | Defines the URL link for the page link. Must be the Custom Page URL when creating a page link to a Custom Page. |
mode | Type: Enum Required Allowed values:
| Determines which action redirects the user to a custom URL or Custom Page. |
page_type | Type: Enum Required Allowed values:
| Specifies the type of page link. Object is the only allowed value at this time. |
object | Type: Component | Specifies the object that the page link will override behavior for. |
page | Type: Component | Reference to a Custom Page. For example, Page.hello_world__c. Required to create a page link to a Custom Page. |
disable_type_select | Type: Boolean | If set to true, Vault bypasses the Object Type select dialog when a user creates a Page Link in the Vault Admin UI. If omitted, the default value is false. This attribute can only be set in CREATE commands. |
Supported Operations
Section link for Supported Operations| Operation | Support |
|---|---|
| Create | |
| Recreate | |
| Alter | |
| Drop | |
| Rename | |
| Describe | |
| Generate Recreate | |
| Queryable |