Salesforce · Schema

GetAllNavigationItems

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
currentPageUrl string
eTag string
navItems array
nextPageUrl string
View JSON Schema on GitHub

JSON Schema

salesforce-get-all-navigation-items-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "currentPageUrl": {
      "type": "string",
      "example": "https://www.example.com"
    },
    "eTag": {
      "type": "string",
      "example": "example_value"
    },
    "navItems": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "availableInClassic": {
            "type": "boolean",
            "example": true
          },
          "availableInLightning": {
            "type": "boolean",
            "example": true
          },
          "color": {
            "type": "['string', 'null']",
            "example": "example_value"
          },
          "content": {
            "type": "string",
            "example": "example_value"
          },
          "custom": {
            "type": "boolean",
            "example": true
          },
          "developerName": {
            "type": "string",
            "example": "example_value"
          },
          "iconUrl": {
            "type": "['string', 'null']",
            "example": "https://www.example.com"
          },
          "id": {
            "type": "['string', 'null']",
            "example": "abc123"
          },
          "itemType": {
            "type": "string",
            "example": "example_value"
          },
          "label": {
            "type": "string",
            "example": "Example Title"
          },
          "objectApiName": {
            "type": "string",
            "example": "example_value"
          },
          "objectLabel": {
            "type": "string",
            "example": "example_value"
          },
          "objectLabelPlural": {
            "type": "string",
            "example": "example_value"
          },
          "pageReference": {
            "type": "object",
            "properties": {
              "attributes": {
                "type": "object",
                "properties": {
                  "objectApiName": {
                    "type": "string",
                    "example": "example_value"
                  },
                  "actionName": {
                    "type": "string",
                    "example": "example_value"
                  }
                },
                "required": [
                  "objectApiName",
                  "actionName"
                ]
              },
              "state": {
                "type": "object",
                "example": "example_value"
              },
              "type": {
                "type": "string",
                "example": "example_value"
              }
            },
            "required": [
              "attributes",
              "state",
              "type"
            ]
          },
          "standardType": {
            "type": "['string', 'null']",
            "example": "example_value"
          }
        },
        "required": [
          "availableInClassic",
          "availableInLightning",
          "color",
          "content",
          "custom",
          "developerName",
          "iconUrl",
          "id",
          "itemType",
          "label",
          "objectApiName",
          "objectLabel",
          "objectLabelPlural",
          "pageReference",
          "standardType"
        ]
      }
    },
    "nextPageUrl": {
      "type": "string",
      "example": "https://www.example.com"
    }
  },
  "required": [
    "currentPageUrl",
    "eTag",
    "navItems",
    "nextPageUrl"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "GetAllNavigationItems"
}