afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/NavigationMenuItem.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "field_reference"
  ],
  "title": "NavigationMenuItem - Data API",
  "description": "Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your Experience Cloud site’s navigation menu. This object is available in API version 35.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AccessRestriction": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Determines if the menu item is available to guest users who aren’t required to log in to the Experience Cloud site."
    },
    "DefaultListViewId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "If the value of the Type field is SalesforceObject, the value is the ID of the default list view for the object."
    },
    "DraftRowID": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the draft navigation menu item. The ID is unique within your organization."
    },
    "Label": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The text that appears in the navigation menu for this item."
    },
    "NavigationLinkSetId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The navigation menu that this item is included in."
    },
    "ParentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The parent navigation menu."
    },
    "Position": {
      "type": "int",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The location of the menu item in the navigation menu."
    },
    "Status": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "Represents if the navigation menu item is published or not. The values can only be DRAFT, LIVE, or null. In API versions 42 and earlier, if the Status field is not set, the field defaults to LIVE. When queried and Status is not part of the query filter, only the NavigationMenuItem objects with a status of LIVE return. In API versions 43 and later, if the Status field is not set, the field defaults to DRAFT. When queried and Status is not part of the query filter, all NavigationMenuItem objects return regardless of status."
    },
    "Target": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "If Type is ExternalLink or InternalLink, the target is the URL that the link points to. For ExternalLink, your entry looks like this: https://salesforce.com. For InternalLink, use a relative URL, such as /contactsupport."
    },
    "TargetPrefs": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "If Type is ExternalLink, determines whether a navigation menu item opens in the same tab."
    },
    "Type": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The type of navigation menu item. The available values are: SalesforceObject—Available objects include accounts, cases, contacts, and custom objects. ExternalLink—Links to a URL outside of your Experience Cloud site. For example, https://salesforce.com. Event—An event, such as logging in, logging out, or switching accounts. Event is internal only and can’t be used in custom components. GlobalAction—Enables users to create object records, but the new record has no relationship with other records. InternalLink—Links to a relative URL inside your Experience Cloud site. For example, /contactsupport. NavigationalTopic—A dropdown list with links to the navigational topics in your Experience Cloud site. SystemLink—A system link, such as a link to Experience Builder, Workspaces, or Salesforce setup."
    }
  },
  "special_access_rules": "Navigation menus are available only in Experience Cloud sites created using Experience Builder templates. To use navigation menus in LWR templates, you must build a custom navigation menu component.",
  "usage": "You can add up to 20 navigation menu items. You can translate navigation menu items using the Translation Workbench.",
  "field_reference": {
    "AccessRestriction": {
      "field_label": "Access Restriction",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DefaultListViewId": {
      "field_label": "List View ID",
      "type": "reference",
      "length": "18"
    },
    "DraftRowId": {
      "field_label": "Navigation Menu Item ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Navigation Menu Item ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Label": {
      "field_label": "Label",
      "type": "string",
      "length": "50"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "NavigationLinkSetId": {
      "field_label": "Navigation Link Set ID",
      "type": "reference",
      "length": "18"
    },
    "ParentId": {
      "field_label": "Navigation Menu Item ID",
      "type": "reference",
      "length": "18"
    },
    "Position": {
      "field_label": "Position",
      "type": "int",
      "digits": "9"
    },
    "Status": {
      "field_label": "Publish Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Target": {
      "field_label": "Target",
      "type": "string",
      "length": "255"
    },
    "TargetPrefs": {
      "field_label": "Target Preferences",
      "type": "picklist",
      "length": "255"
    },
    "Type": {
      "field_label": "Navigation Menu Item Type",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}