Chilkat Online Tools

Ruby / Salesforce Platform APIs / Update a Batch of Favorites

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "favorites": [
#     {
#       "id": "0MVR00000004DhnOAE",
#       "name": "Q4 Perf"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("favorites[0].id","0MVR00000004DhnOAE")
json.UpdateString("favorites[0].name","Q4 Perf")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/services/data/v{{version}}/ui-api/favorites/batch",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

i = 0
count_i = jResp.SizeOfArray("favorites")
while i < count_i
    jResp.put_I(i)
    accessCount = jResp.IntOf("favorites[i].accessCount")
    iconColor = jResp.stringOf("favorites[i].iconColor")
    iconUrl = jResp.stringOf("favorites[i].iconUrl")
    id = jResp.stringOf("favorites[i].id")
    lastAccessDate = jResp.stringOf("favorites[i].lastAccessDate")
    name = jResp.stringOf("favorites[i].name")
    objectType = jResp.stringOf("favorites[i].objectType")
    sortOrder = jResp.IntOf("favorites[i].sortOrder")
    subtitle = jResp.stringOf("favorites[i].subtitle")
    target = jResp.stringOf("favorites[i].target")
    targetType = jResp.stringOf("favorites[i].targetType")
    i = i + 1
end

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "favorites": [
        {
            "id": "0MVR00000004DhnOAE",
            "name": "Q4 Perf"
        }
    ]
}'
https://domain.com/services/data/v{{version}}/ui-api/favorites/batch

Postman Collection Item JSON

{
  "name": "Update a Batch of Favorites",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"favorites\": [\n        {\n            \"id\": \"0MVR00000004DhnOAE\",\n            \"name\": \"Q4 Perf\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/batch",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "favorites",
        "batch"
      ]
    },
    "description": "Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted."
  },
  "response": [
    {
      "name": "Update a Batch of Favorites",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"favorites\": [\n        {\n            \"id\": \"0MV4H0000004qIeWAI\",\n            \"name\": \"RenamedAllAcountsListView\"\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/batch",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "favorites",
            "batch"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:07:35 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    \"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\": \"RenamedAllAcountsListView\",\n            \"objectType\": \"Account\",\n            \"sortOrder\": 1,\n            \"subtitle\": \"Accounts\",\n            \"target\": \"00B58000002ssinEAA\",\n            \"targetType\": \"ListView\"\n        }\n    ]\n}"
    }
  ]
}