Chilkat Online Tools

Delphi (ActiveX) / Salesforce Platform APIs / Get an App

Back to Collection Items

var

begin
queryParams.UpdateString('formFactor','Small');http.AuthToken := '<access_token>';resp.GetBodySb(sbResponseBody.ControlInterface);jResp.LoadSb(sbResponseBody.ControlInterface);jResp.EmitCompact := 0;jResp.I := i;strVal := jResp.StringOf('formFactors[i]');i := i + 1;i := 0;count_i := jResp.SizeOfArray('navItems');jResp.I := i;availableInClassic := jResp.BoolOf('navItems[i].availableInClassic');availableInLightning := jResp.BoolOf('navItems[i].availableInLightning');color := jResp.StringOf('navItems[i].color');content := jResp.StringOf('navItems[i].content');custom := jResp.BoolOf('navItems[i].custom');developerName := jResp.StringOf('navItems[i].developerName');iconUrl := jResp.StringOf('navItems[i].iconUrl');id := jResp.StringOf('navItems[i].id');itemType := jResp.StringOf('navItems[i].itemType');label := jResp.StringOf('navItems[i].label');objectApiName := jResp.StringOf('navItems[i].objectApiName');objectLabel := jResp.StringOf('navItems[i].objectLabel');objectLabelPlural := jResp.StringOf('navItems[i].objectLabelPlural');ObjectApiName := jResp.StringOf('navItems[i].pageReference.attributes.objectApiName');ActionName := jResp.StringOf('navItems[i].pageReference.attributes.actionName');v_Type := jResp.StringOf('navItems[i].pageReference.type');standardType := jResp.StringOf('navItems[i].standardType');PageName := jResp.StringOf('navItems[i].pageReference.attributes.pageName');i := i + 1;i := 0;count_i := jResp.SizeOfArray('userNavItems');jResp.I := i;i := i + 1;

Curl Command

curl -G -d "formFactor=Small"
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/apps/:APP_ID

Postman Collection Item JSON

{
  "name": "Get an App",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/apps/:APP_ID?formFactor=Small",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "apps",
        ":APP_ID"
      ],
      "query": [
        {
          "key": "formFactor",
          "value": "Small",
          "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)"
        },
        {
          "key": "userCustomizations",
          "value": "true",
          "description": "If true, gets custom and standard navigation tabs. If false, gets only standard navigation tabs.",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "APP_ID",
          "value": "",
          "description": "Application ID"
        }
      ]
    },
    "description": "Get metadata about an app."
  },
  "response": [
    {
      "name": "Get an App",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/apps/:APP_ID?formFactor=Small",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "apps",
            ":APP_ID"
          ],
          "query": [
            {
              "key": "formFactor",
              "value": "Small",
              "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)"
            },
            {
              "key": "userCustomizations",
              "value": "true",
              "description": "If true, gets custom and standard navigation tabs. If false, gets only standard navigation tabs.",
              "disabled": true
            }
          ],
          "variable": [
            {
              "key": "APP_ID",
              "value": "06m58000000fBK2AAM",
              "description": "Application ID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 09:35:36 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "ETag",
          "value": "\"21d4bafc5c5730c4f9421875288c4a00--gzip\""
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"appId\": \"06m58000000fBK2AAM\",\n    \"description\": \"Manage your sales process with accounts, leads, opportunities, and more\",\n    \"developerName\": \"LightningSales\",\n    \"eTag\": \"21d4bafc5c5730c4f9421875288c4a00\",\n    \"formFactors\": [\n        \"Small\",\n        \"Medium\",\n        \"Large\"\n    ],\n    \"headerColor\": \"#0070D2\",\n    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/SalesCloud/icon.png\",\n    \"isNavAutoTempTabsDisabled\": false,\n    \"isNavPersonalizationDisabled\": false,\n    \"isNavTabPersistenceDisabled\": false,\n    \"label\": \"Sales\",\n    \"logoUrl\": \"https://pozil-dev-ed.my.salesforce.com/logos/Salesforce/SalesCloud/logo.png\",\n    \"mobileStartUrl\": null,\n    \"navItems\": [\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"FF5D2D\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/006/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Opportunity\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/opportunity_120.png\",\n            \"id\": null,\n            \"itemType\": \"Entity\",\n            \"label\": \"Opportunities\",\n            \"objectApiName\": \"Opportunity\",\n            \"objectLabel\": \"Opportunity\",\n            \"objectLabelPlural\": \"Opportunities\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Opportunity\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": null\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"FF5D2D\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/00Q/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Lead\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/lead_120.png\",\n            \"id\": null,\n            \"itemType\": \"Entity\",\n            \"label\": \"Leads\",\n            \"objectApiName\": \"Lead\",\n            \"objectLabel\": \"Lead\",\n            \"objectLabelPlural\": \"Leads\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Lead\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": null\n        },\n        {\n            \"availableInClassic\": false,\n            \"availableInLightning\": true,\n            \"color\": \"3BA755\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/00T/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Task\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/task_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Tasks\",\n            \"objectApiName\": \"Task\",\n            \"objectLabel\": \"Task\",\n            \"objectLabelPlural\": \"Tasks\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Task\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": \"Tasks\"\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"939393\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/files/FileTabPage\",\n            \"custom\": false,\n            \"developerName\": \"standard-File\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/file_120.png\",\n            \"id\": null,\n            \"itemType\": \"Entity\",\n            \"label\": \"Files\",\n            \"objectApiName\": \"ContentDocument\",\n            \"objectLabel\": null,\n            \"objectLabelPlural\": null,\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"ContentDocument\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": null\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"5867E8\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/001/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Account\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n            \"id\": null,\n            \"itemType\": \"Entity\",\n            \"label\": \"Accounts\",\n            \"objectApiName\": \"Account\",\n            \"objectLabel\": \"Account\",\n            \"objectLabelPlural\": \"Accounts\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Account\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": null\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"5867E8\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/003/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Contact\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/contact_120.png\",\n            \"id\": null,\n            \"itemType\": \"Entity\",\n            \"label\": \"Contacts\",\n            \"objectApiName\": \"Contact\",\n            \"objectLabel\": \"Contact\",\n            \"objectLabelPlural\": \"Contacts\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Contact\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": null\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"FF538A\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/01Z/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Dashboard\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/dashboard_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Dashboards\",\n            \"objectApiName\": \"Dashboard\",\n            \"objectLabel\": \"Dashboard\",\n            \"objectLabelPlural\": \"Dashboards\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Dashboard\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": \"Dashboards\"\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"06A59A\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/00O/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-report\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Reports\",\n            \"objectApiName\": \"Report\",\n            \"objectLabel\": \"Report\",\n            \"objectLabelPlural\": \"Reports\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Report\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": \"Reports\"\n        },\n        {\n            \"availableInClassic\": false,\n            \"availableInLightning\": true,\n            \"color\": \"1B96FF\",\n            \"content\": null,\n            \"custom\": false,\n            \"developerName\": \"standard-Feed\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/feed_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Chatter\",\n            \"objectApiName\": \"Feed\",\n            \"objectLabel\": null,\n            \"objectLabelPlural\": null,\n            \"pageReference\": {\n                \"attributes\": {\n                    \"pageName\": \"chatter\"\n                },\n                \"state\": {},\n                \"type\": \"standard__namedPage\"\n            },\n            \"standardType\": \"Feed\"\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"1B96FF\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/groups/GroupListPage\",\n            \"custom\": false,\n            \"developerName\": \"standard-CollaborationGroup\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/groups_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Groups\",\n            \"objectApiName\": \"CollaborationGroup\",\n            \"objectLabel\": \"Group\",\n            \"objectLabelPlural\": \"Groups\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"CollaborationGroup\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": \"Groups\"\n        },\n        {\n            \"availableInClassic\": false,\n            \"availableInLightning\": true,\n            \"color\": \"FF538A\",\n            \"content\": null,\n            \"custom\": false,\n            \"developerName\": \"Events\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/event_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Events\",\n            \"objectApiName\": \"Event\",\n            \"objectLabel\": \"Event\",\n            \"objectLabelPlural\": \"Events\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Event\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": \"Events\"\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"1B96FF\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/_ui/core/chatter/people/PeopleListPage\",\n            \"custom\": false,\n            \"developerName\": \"standard-OtherUserProfile\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/user_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"People\",\n            \"objectApiName\": \"User\",\n            \"objectLabel\": \"User\",\n            \"objectLabelPlural\": \"People\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"User\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": \"People\"\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"FF5D2D\",\n            \"content\": \"https://pozil-dev-ed.my.salesforce.com/500/o\",\n            \"custom\": false,\n            \"developerName\": \"standard-Case\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/case_120.png\",\n            \"id\": null,\n            \"itemType\": \"Entity\",\n            \"label\": \"Cases\",\n            \"objectApiName\": \"Case\",\n            \"objectLabel\": \"Case\",\n            \"objectLabelPlural\": \"Cases\",\n            \"pageReference\": {\n                \"attributes\": {\n                    \"objectApiName\": \"Case\",\n                    \"actionName\": \"home\"\n                },\n                \"state\": {},\n                \"type\": \"standard__objectPage\"\n            },\n            \"standardType\": null\n        },\n        {\n            \"availableInClassic\": true,\n            \"availableInLightning\": true,\n            \"color\": \"3BA755\",\n            \"content\": null,\n            \"custom\": false,\n            \"developerName\": \"ForecastingLightning\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/forecasts_120.png\",\n            \"id\": null,\n            \"itemType\": \"Standard\",\n            \"label\": \"Forecasts\",\n            \"objectApiName\": null,\n            \"objectLabel\": null,\n            \"objectLabelPlural\": null,\n            \"pageReference\": {\n                \"attributes\": {\n                    \"pageName\": \"forecasting\"\n                },\n                \"state\": {},\n                \"type\": \"standard__namedPage\"\n            },\n            \"standardType\": \"ForecastingLightning\"\n        }\n    ],\n    \"selected\": true,\n    \"startUrl\": \"https://pozil-dev-ed.my.salesforce.com/home/home.jsp?tsid=02u58000000fBK2\",\n    \"type\": \"Lightning\",\n    \"userNavItems\": []\n}"
    }
  ]
}