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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ApexPageInfo - Data API",
  "description": "Represents metadata about a single Visualforce page. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ApexPageId": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "ID for the Visualforce page."
    },
    "ApiVersion": {
      "type": "double",
      "properties": "Filter, Sort",
      "description": "The API version for the page. Every page has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0."
    },
    "Description": {
      "type": "textarea",
      "properties": "Filter, Nillable, Sort",
      "description": "Description of the Visualforce page."
    },
    "DurableId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "For internal use only."
    },
    "IsAvailableInTouch": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates if Visualforce tabs associated with the Visualforce page can be used in the Salesforce app (true) or not (false). The default value is false."
    },
    "IsShowHeader": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The showHeader value for the Visualforce page. This will be “unknown” if the Visualforce page uses an expression to compute showHeader. The default value is true."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The text used to identify the Visualforce page in the Setup area of Salesforce."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "Developer name of the Visualforce page."
    },
    "NameSpacePrefix": {
      "type": "string",
      "properties": "Filter, Nillable, Sort",
      "description": "The namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, the namespace prefix is set to the namespace prefix of the org for all objects that support it. Note: If an object is in an installed managed package, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In non-Developer Edition orgs, NamespacePrefix is only set for objects that are part of an installed managed package. Objects outside of an installed managed package do not have a namespace prefix."
    }
  },
  "special_access_rules": "As of Summer '20 and later, this object can only be accessed by users who can view a particular Visualforce page, and users with the View Setup and Configuration permission.",
  "usage": "Use ApexPageInfo to query limited metadata about Visualforce pages. Some of this metadata corresponds to settings for a Visualforce page available in Visualforce Pages. To access Visualforce Pages, from Setup, in the Quick Find box, enter Custom Code. Then, select Visualforce Pages. Other values are only available via API. Use ApexPageInfo in Visualforce pages to add custom content that extends the base Salesforce application functionality. Users can only query ApexPageInfo records if they can display the associated Visualforce page, or if they have the View Setup & Configuration permission. Allow users to view Visualforce pages by modifying their user profile or assigning permission sets.\n\nUse ApexPageInfo to query limited metadata about Visualforce pages. Some of this metadata corresponds to settings for a Visualforce page available in Visualforce Pages. To access Visualforce Pages, from Setup, in the Quick Find box, enter Custom Code. Then, select Visualforce Pages. Other values are only available via API. Use ApexPageInfo in Visualforce pages to add custom content that extends the base Salesforce application functionality.\n\nUsers can only query ApexPageInfo records if they can display the associated Visualforce page, or if they have the View Setup & Configuration permission. Allow users to view Visualforce pages by modifying their user profile or assigning permission sets.",
  "wsdl_segment": "```xml\n<complexType name=\"ApexPageInfo\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ApexPageId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ApiVersion\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DurableId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsAvailableInTouch\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsShowHeader\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NameSpacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "ApexPageId": {
      "field_label": "Apex Page ID",
      "type": "string",
      "length": "18"
    },
    "ApiVersion": {
      "field_label": "API Version",
      "type": "double",
      "precision": "18",
      "scale": "1"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "1333"
    },
    "DurableId": {
      "field_label": "Durable ID",
      "type": "string",
      "length": "255"
    },
    "Id": {
      "field_label": "Entity Id",
      "type": "id",
      "length": "18"
    },
    "IsAvailableInTouch": {
      "field_label": "Is Available In Touch",
      "type": "boolean"
    },
    "IsShowHeader": {
      "field_label": "Show Header",
      "type": "string",
      "length": "80"
    },
    "MasterLabel": {
      "field_label": "Master Label",
      "type": "string",
      "length": "80"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "80"
    },
    "NameSpacePrefix": {
      "field_label": "Name Space Prefix",
      "type": "string",
      "length": "512"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}