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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "AppMenuItem - Data API",
  "description": "Represents the organization’s default settings for items in the app menu or App Launcher.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ApplicationId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The 15-character ID for the menu item."
    },
    "CanvasAccessMethod": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The access method for the canvas app. Values can be: Get—OAuth Webflow Post—Signed Request"
    },
    "CanvasEnabled": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates if the app menu item is a canvas app (true) or not (false). The default setting is false."
    },
    "CanvasOptions": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Represents the options enabled for a canvas connected app. The options are: PersonalEnabled—The app is enabled as a canvas personal app. HideHeader—The publisher header, which contains the “What are you working on?” text, is hidden. HideShare—The publisher Share button is hidden. This field is available in API version 34.0 and later."
    },
    "CanvasReferenceId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The canvas app unique identifier."
    },
    "CanvasSelectedLocations": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The selected locations for the canvas app which define where the canvas app can appear in the user interface. For example:Chatter,ChatterFeed,Publisher,ServiceDesk"
    },
    "CanvasUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The URL of the canvas app."
    },
    "Description": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "A description of this menu item."
    },
    "IconUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The icon for the menu item’s application."
    },
    "InfoUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The URL for more information about the application."
    },
    "IsAccessible": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "If true, the current user is authorized to use the app. The default setting is false."
    },
    "IsRegisteredDeviceOnly": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "If true, indicates that the app is available to registered devices only. The default setting is false. Available in API version 49.0 and later."
    },
    "IsUsingAdminAuthorization": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "If true, the app is pre-authorized for certain users by the administrator. The default setting is false."
    },
    "IsVisible": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort, Update",
      "description": "If true, the app is visible to users of the organization. The default setting is false."
    },
    "Label": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The app’s name."
    },
    "LogoUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The logo for the menu item’s application. The default is the initials of the Label value."
    },
    "MobileAppBinaryId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The URL for the Mobile App Binary file."
    },
    "MobileAppInstallUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The location mobile users are directed to install the app. Available in API version 49.0 and later."
    },
    "MobileAppInstalledDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time that a user installed a mobile app. Available in API version 49.0 and later."
    },
    "MobileAppInstalledVersion": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The version of the user’s installed mobile app. Available in API version 49.0 and later."
    },
    "MobileAppVer": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The version number of the mobile app. Available in API version 49.0 and later."
    },
    "MobileDeviceType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The supported device form factors for the mobile app. Available in API version 49.0 and later."
    },
    "MobileMinOsVer": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The minimum version required for the app. Available in API version 49.0 and later."
    },
    "MobilePlatform": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The mobile platform for the app. Possible values include: android – Android ios – iOS Available in API version 49.0 and later."
    },
    "MobileStartUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The location mobile users are directed to after they’ve authenticated. This field is used with connected apps and Experience Builder sites. For sites only, this location is a fully qualified domain name. For other apps, it’s a relative URL."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The API name of the item."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is 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, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, 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 orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
    },
    "SortOrder": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "The index value that controls where this item appears in the menu. For example, a menu item with a sort order of 5 appears between items with sort order values of 3 and 9."
    },
    "StartUrl": {
      "type": "url",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "For a connected app, the location users are directed to after they’ve authenticated. Otherwise, the application’s default start page."
    },
    "Type": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The type of application represented by this item. The types are: ConnectedApplication Network ServiceProvider TabSet"
    },
    "UserSortOrder": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The index value that represents where the user set this item in the menu (or App Launcher). For example, an item with a sort order value of 5 appears between items with sort order values of 3 and 9. This value is separate from SortOrder so you can create logic incorporating both values. For example, if you want the user-sorted items to appear first, followed by the organization order for the rest, use: SELECT ApplicationId,SortOrder,UserSortOrder FROM AppMenuItem order by userSortOrder NULLS LAST, sortOrder NULLS LAST"
    }
  },
  "usage": "Use this read-only object to view an entry in the Lightning Platform app menu or the App Launcher. You can create a SOQL query to retrieve all items, even items the user does not see from the user interface.\n\nThere are many ways you can use AppMenuItem. Here are some examples:\n\nBuild your own App Launcher or app menu in Salesforce. Create a custom page\n\t\t\t\t\t\tshowing all the apps you have access to and that lets you run them using\n\t\t\t\t\t\tsingle sign-on.\n\nBuild your own App Launcher or app menu on a tablet or mobile app. You can\n\t\t\t\t\t\thave your own app for launching applications on various mobile devices.\n\nBuild an app launcher into your company’s intranet. There’s no need to have\n\t\t\t\t\t\tit run on Salesforce because Salesforce APIs let you integrate with\n\t\t\t\t\t\tSalesforce programmatically and build an app launcher.\n\nTo get metadata information about apps and their tabs, use the Apex\n\nSchema.describeTabs()\n\nmethod, REST API\n\n/vXX.X/tabs/\n\nresource, or SOAP API\n\ndescribeTabs()",
  "wsdl_segment": "```xml\n<complexType name=\"AppMenuItem\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ApplicationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CanvasAccessMethod\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CanvasEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"CanvasOptions\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CanvasReferenceId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CanvasSelectedLocations\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CanvasUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IconUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"InfoUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsAccessible\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsRegisteredDeviceOnly\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsUsingAdminAuthorization\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsVisible\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LogoUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileAppBinaryId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileAppInstallUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileAppInstalledDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MobileAppInstalledVersion\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileAppVer\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileDeviceType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileMinOsVer\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobilePlatform\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MobileStartUrl\" 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        <element name=\"SortOrder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"StartUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserSortOrder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n```",
  "field_reference": {
    "ApplicationId": {
      "field_label": "Application ID",
      "type": "reference",
      "length": "18"
    },
    "CanvasAccessMethod": {
      "field_label": "The configured access method for the canvas application",
      "type": "picklist",
      "length": "255"
    },
    "CanvasEnabled": {
      "field_label": "Is this a canvas-enabled application",
      "type": "boolean"
    },
    "CanvasOptions": {
      "field_label": "The options to hide publisher header or publisher share button",
      "type": "string",
      "length": "255"
    },
    "CanvasReferenceId": {
      "field_label": "The identifier used to render the canvas application.",
      "type": "string",
      "length": "18"
    },
    "CanvasSelectedLocations": {
      "field_label": "The selected/supported locations of the canvas application",
      "type": "string",
      "length": "255"
    },
    "CanvasUrl": {
      "field_label": "The canvas URL for the canvas application",
      "type": "url",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Description": {
      "field_label": "Description",
      "type": "string",
      "length": "250"
    },
    "IconUrl": {
      "field_label": "Icon URL",
      "type": "url",
      "length": "255"
    },
    "Id": {
      "field_label": "AppMenuItem ID",
      "type": "id",
      "length": "18"
    },
    "InfoUrl": {
      "field_label": "Info URL",
      "type": "url",
      "length": "255"
    },
    "IsAccessible": {
      "field_label": "Is Accessible",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsRegisteredDeviceOnly": {
      "field_label": "App requires a registered mobile device",
      "type": "boolean"
    },
    "IsUsingAdminAuthorization": {
      "field_label": "IsUsingAdminAuthorization",
      "type": "boolean"
    },
    "IsVisible": {
      "field_label": "Is Visible",
      "type": "boolean"
    },
    "Label": {
      "field_label": "Label",
      "type": "string",
      "length": "250"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LogoUrl": {
      "field_label": "Logo Image URL",
      "type": "url",
      "length": "255"
    },
    "MobileAppBinaryId": {
      "field_label": "ID for the related mobile app binary",
      "type": "string",
      "length": "255"
    },
    "MobileAppInstallUrl": {
      "field_label": "URL to install the mobile app",
      "type": "url",
      "length": "255"
    },
    "MobileAppInstalledDate": {
      "field_label": "Date the mobile app was most recently installed",
      "type": "datetime"
    },
    "MobileAppInstalledVersion": {
      "field_label": "Most recently installed version of the mobile app",
      "type": "string",
      "length": "255"
    },
    "MobileAppVer": {
      "field_label": "Version of the mobile app",
      "type": "string",
      "length": "255"
    },
    "MobileDeviceType": {
      "field_label": "Type of mobile device",
      "type": "string",
      "length": "255"
    },
    "MobileMinOsVer": {
      "field_label": "Minimum required mobile device OS version",
      "type": "string",
      "length": "255"
    },
    "MobilePlatform": {
      "field_label": "Mobile device OS platform",
      "type": "picklist",
      "length": "255"
    },
    "MobileStartUrl": {
      "field_label": "Mobile Start URL",
      "type": "url",
      "length": "255"
    },
    "Name": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "80"
    },
    "SortOrder": {
      "field_label": "Sort Order",
      "type": "int",
      "digits": "9"
    },
    "StartUrl": {
      "field_label": "Start URL",
      "type": "url",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Type": {
      "field_label": "App Type",
      "type": "picklist",
      "length": "255"
    },
    "UserSortOrder": {
      "field_label": "User Sort Order",
      "type": "int",
      "digits": "9"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}