Chilkat Online Tools

delphiDll / Salesforce Platform APIs / Update a Batch of Favorites

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
accessCount: Integer;
iconColor: PWideChar;
iconUrl: PWideChar;
id: PWideChar;
lastAccessDate: PWideChar;
name: PWideChar;
objectType: PWideChar;
sortOrder: Integer;
subtitle: PWideChar;
target: PWideChar;
targetType: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

// 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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'favorites[0].id','0MVR00000004DhnOAE');
CkJsonObject_UpdateString(json,'favorites[0].name','Q4 Perf');

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://domain.com/services/data/v{{version}}/ui-api/favorites/batch',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// 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 := CkJsonObject_SizeOfArray(jResp,'favorites');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    accessCount := CkJsonObject_IntOf(jResp,'favorites[i].accessCount');
    iconColor := CkJsonObject__stringOf(jResp,'favorites[i].iconColor');
    iconUrl := CkJsonObject__stringOf(jResp,'favorites[i].iconUrl');
    id := CkJsonObject__stringOf(jResp,'favorites[i].id');
    lastAccessDate := CkJsonObject__stringOf(jResp,'favorites[i].lastAccessDate');
    name := CkJsonObject__stringOf(jResp,'favorites[i].name');
    objectType := CkJsonObject__stringOf(jResp,'favorites[i].objectType');
    sortOrder := CkJsonObject_IntOf(jResp,'favorites[i].sortOrder');
    subtitle := CkJsonObject__stringOf(jResp,'favorites[i].subtitle');
    target := CkJsonObject__stringOf(jResp,'favorites[i].target');
    targetType := CkJsonObject__stringOf(jResp,'favorites[i].targetType');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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