Chilkat Online Tools

autoit / Salesforce Platform APIs / Get Favorites

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>"

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

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.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)

; {
;   "favorites": [
;     {
;       "accessCount": 1,
;       "iconColor": "5867E8",
;       "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
;       "id": "0MV4H0000004qIeWAI",
;       "lastAccessDate": "2023-10-06T10:03:32.000Z",
;       "name": "AllAccountsListView",
;       "objectType": "Account",
;       "sortOrder": 1,
;       "subtitle": "Accounts",
;       "target": "00B58000002ssinEAA",
;       "targetType": "ListView"
;     }
;   ]
; }

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

Local $iAccessCount
Local $sIconColor
Local $sIconUrl
Local $sId
Local $sLastAccessDate
Local $sName
Local $sObjectType
Local $iSortOrder
Local $subtitle
Local $sTarget
Local $sTargetType

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("favorites")
While $i < $iCount_i
    $oJResp.I = $i
    $iAccessCount = $oJResp.IntOf("favorites[i].accessCount")
    $sIconColor = $oJResp.StringOf("favorites[i].iconColor")
    $sIconUrl = $oJResp.StringOf("favorites[i].iconUrl")
    $sId = $oJResp.StringOf("favorites[i].id")
    $sLastAccessDate = $oJResp.StringOf("favorites[i].lastAccessDate")
    $sName = $oJResp.StringOf("favorites[i].name")
    $sObjectType = $oJResp.StringOf("favorites[i].objectType")
    $iSortOrder = $oJResp.IntOf("favorites[i].sortOrder")
    $subtitle = $oJResp.StringOf("favorites[i].subtitle")
    $sTarget = $oJResp.StringOf("favorites[i].target")
    $sTargetType = $oJResp.StringOf("favorites[i].targetType")
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/favorites

Postman Collection Item JSON

{
  "name": "Get Favorites",
  "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/favorites",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "favorites"
      ]
    },
    "description": "Get all of a user’s favorites."
  },
  "response": [
    {
      "name": "Get Favorites",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "favorites"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:03:55 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": "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    \"favorites\": [\n        {\n            \"accessCount\": 1,\n            \"iconColor\": \"5867E8\",\n            \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n            \"id\": \"0MV4H0000004qIeWAI\",\n            \"lastAccessDate\": \"2023-10-06T10:03:32.000Z\",\n            \"name\": \"AllAccountsListView\",\n            \"objectType\": \"Account\",\n            \"sortOrder\": 1,\n            \"subtitle\": \"Accounts\",\n            \"target\": \"00B58000002ssinEAA\",\n            \"targetType\": \"ListView\"\n        }\n    ]\n}"
    }
  ]
}