Chilkat Online Tools

autoit / Salesforce Platform APIs / Tabs

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tabs",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJarrResp = ObjCreate("Chilkat.JsonArray")
$oJarrResp.LoadSb($oSbResponseBody)
$oJarrResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJarrResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; [
;   {
;     "colors": [
;       {
;         "color": "5867E8",
;         "context": "primary",
;         "theme": "theme4"
;       },
;       {
;         "color": "236FBD",
;         "context": "primary",
;         "theme": "theme3"
;       }
;     ],
;     "custom": false,
;     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
;     "icons": [
;       {
;         "contentType": "image/png",
;         "height": 32,
;         "theme": "theme3",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
;         "width": 32
;       },
;       {
;         "contentType": "image/png",
;         "height": 16,
;         "theme": "theme3",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
;         "width": 16
;       },
;       {
;         "contentType": "image/svg+xml",
;         "height": 0,
;         "theme": "theme4",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg",
;         "width": 0
;       },
;       {
;         "contentType": "image/png",
;         "height": 60,
;         "theme": "theme4",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png",
;         "width": 60
;       },
;       {
;         "contentType": "image/png",
;         "height": 120,
;         "theme": "theme4",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
;         "width": 120
;       }
;     ],
;     "label": "Accounts",
;     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
;     "name": "standard-Account",
;     "sobjectName": "Account",
;     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/001/o"
;   },
;   {
;     "colors": [
;       {
;         "color": "056764",
;         "context": "primary",
;         "theme": "theme4"
;       },
;       {
;         "color": "056764",
;         "context": "primary",
;         "theme": "theme3"
;       }
;     ],
;     "custom": false,
;     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png",
;     "icons": [
;       {
;         "contentType": "image/png",
;         "height": 32,
;         "theme": "theme3",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png",
;         "width": 32
;       },
;       {
;         "contentType": "image/png",
;         "height": 16,
;         "theme": "theme3",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png",
;         "width": 16
;       }
;     ],
;     "label": "Active Scratch Orgs",
;     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png",
;     "name": "standard-ActiveScratchOrg",
;     "sobjectName": "ActiveScratchOrg",
;     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/2AS/o"
;   },
;   {
;     "colors": [
;       {
;         "color": "06A59A",
;         "context": "primary",
;         "theme": "theme4"
;       },
;       {
;         "color": "A55647",
;         "context": "primary",
;         "theme": "theme3"
;       }
;     ],
;     "custom": false,
;     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png",
;     "icons": [
;       {
;         "contentType": "image/png",
;         "height": 32,
;         "theme": "theme3",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png",
;         "width": 32
;       },
;       {
;         "contentType": "image/png",
;         "height": 16,
;         "theme": "theme3",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png",
;         "width": 16
;       },
;       {
;         "contentType": "image/svg+xml",
;         "height": 0,
;         "theme": "theme4",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report.svg",
;         "width": 0
;       },
;       {
;         "contentType": "image/png",
;         "height": 60,
;         "theme": "theme4",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_60.png",
;         "width": 60
;       },
;       {
;         "contentType": "image/png",
;         "height": 120,
;         "theme": "theme4",
;         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png",
;         "width": 120
;       }
;     ],
;     "label": "Reports",
;     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png",
;     "name": "standard-report",
;     "sobjectName": "Report",
;     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/00O/o"
;   }
; ]

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $oJson
Local $bCustom
Local $sIconUrl
Local $sLabel
Local $sMiniIconUrl
Local $sName
Local $sobjectName
Local $sUrl
Local $iJ
Local $iCount_j
Local $sColor
Local $sContext
Local $sTheme
Local $sContentType
Local $iHeight
Local $iWidth

Local $i = 0
Local $iCount_i = $oJarrResp.Size
While $i < $iCount_i
    $oJson = $oJarrResp.ObjectAt($i)
    $bCustom = $oJson.BoolOf("custom")
    $sIconUrl = $oJson.StringOf("iconUrl")
    $sLabel = $oJson.StringOf("label")
    $sMiniIconUrl = $oJson.StringOf("miniIconUrl")
    $sName = $oJson.StringOf("name")
    $sobjectName = $oJson.StringOf("sobjectName")
    $sUrl = $oJson.StringOf("url")
    $iJ = 0
    $iCount_j = $oJson.SizeOfArray("colors")
    While $iJ < $iCount_j
        $oJson.J = $iJ
        $sColor = $oJson.StringOf("colors[j].color")
        $sContext = $oJson.StringOf("colors[j].context")
        $sTheme = $oJson.StringOf("colors[j].theme")
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJson.SizeOfArray("icons")
    While $iJ < $iCount_j
        $oJson.J = $iJ
        $sContentType = $oJson.StringOf("icons[j].contentType")
        $iHeight = $oJson.IntOf("icons[j].height")
        $sTheme = $oJson.StringOf("icons[j].theme")
        $sUrl = $oJson.StringOf("icons[j].url")
        $iWidth = $oJson.IntOf("icons[j].width")
        $iJ = $iJ + 1
    Wend

    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tabs

Postman Collection Item JSON

{
  "name": "Tabs",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tabs",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tabs"
      ]
    },
    "description": "f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm"
  },
  "response": [
    {
      "name": "Tabs",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tabs",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tabs"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 27 Sep 2023 15:29:05 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=6/15000"
        },
        {
          "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    {\n        \"colors\": [\n            {\n                \"color\": \"5867E8\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"236FBD\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n                \"width\": 16\n            },\n            {\n                \"contentType\": \"image/svg+xml\",\n                \"height\": 0,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg\",\n                \"width\": 0\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 60,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png\",\n                \"width\": 60\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 120,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n                \"width\": 120\n            }\n        ],\n        \"label\": \"Accounts\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n        \"name\": \"standard-Account\",\n        \"sobjectName\": \"Account\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/001/o\"\n    },\n    {\n        \"colors\": [\n            {\n                \"color\": \"056764\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"056764\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png\",\n                \"width\": 16\n            }\n        ],\n        \"label\": \"Active Scratch Orgs\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png\",\n        \"name\": \"standard-ActiveScratchOrg\",\n        \"sobjectName\": \"ActiveScratchOrg\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/2AS/o\"\n    },\n    {\n        \"colors\": [\n            {\n                \"color\": \"06A59A\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"A55647\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png\",\n                \"width\": 16\n            },\n            {\n                \"contentType\": \"image/svg+xml\",\n                \"height\": 0,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report.svg\",\n                \"width\": 0\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 60,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_60.png\",\n                \"width\": 60\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 120,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png\",\n                \"width\": 120\n            }\n        ],\n        \"label\": \"Reports\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png\",\n        \"name\": \"standard-report\",\n        \"sobjectName\": \"Report\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/00O/o\"\n    }\n]"
    }
  ]
}