Chilkat Online Tools

lianja / Salesforce Platform APIs / Update Usage of a Favorite

Back to Collection Items

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

loHttp = createobject("CkHttp")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.QuickRequest("PATCH","https://domain.com/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID/usage")
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

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

// {
//   "accessCount": 2,
//   "iconColor": "5867E8",
//   "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
//   "id": "0MV4H0000004qIeWAI",
//   "lastAccessDate": "2023-10-06T10:09:03.304Z",
//   "name": "RenamedAllAcountsListView",
//   "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

lnAccessCount = loJResp.IntOf("accessCount")
lcIconColor = loJResp.StringOf("iconColor")
lcIconUrl = loJResp.StringOf("iconUrl")
lcId = loJResp.StringOf("id")
lcLastAccessDate = loJResp.StringOf("lastAccessDate")
lcName = loJResp.StringOf("name")
lcObjectType = loJResp.StringOf("objectType")
lnSortOrder = loJResp.IntOf("sortOrder")
lcSubtitle = loJResp.StringOf("subtitle")
lcTarget = loJResp.StringOf("target")
lcTargetType = loJResp.StringOf("targetType")


release loHttp
release loSbResponseBody
release loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update Usage of a Favorite",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID/usage",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "favorites",
        ":FAVORITE_ID",
        "usage"
      ],
      "variable": [
        {
          "key": "FAVORITE_ID",
          "value": "",
          "description": "The ID of a favorite"
        }
      ]
    },
    "description": "Update the usage of an individual favorite, for example, the last time and number of times the favorite was clicked."
  },
  "response": [
    {
      "name": "Update Usage of a Favorite",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID/usage",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "favorites",
            ":FAVORITE_ID",
            "usage"
          ],
          "variable": [
            {
              "key": "FAVORITE_ID",
              "value": "0MV4H0000004qIeWAI",
              "description": "The ID of a favorite"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:09:03 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": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"accessCount\": 2,\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:09:03.304Z\",\n    \"name\": \"RenamedAllAcountsListView\",\n    \"objectType\": \"Account\",\n    \"sortOrder\": 1,\n    \"subtitle\": \"Accounts\",\n    \"target\": \"00B58000002ssinEAA\",\n    \"targetType\": \"ListView\"\n}"
    }
  ]
}