Chilkat Online Tools

swift3 / Salesforce Platform APIs / Update a Batch of Favorites

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

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

    let json = CkoJsonObject()!
    json.update("favorites[0].id", value: "0MVR00000004DhnOAE")
    json.update("favorites[0].name", value: "Q4 Perf")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://domain.com/services/data/v{{version}}/ui-api/favorites/batch", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var accessCount: Int
    var iconColor: String?
    var iconUrl: String?
    var id: String?
    var lastAccessDate: String?
    var name: String?
    var objectType: String?
    var sortOrder: Int
    var subtitle: String?
    var target: String?
    var targetType: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "favorites").intValue
    while i < count_i {
        jResp.i = i
        accessCount = jResp.int(of: "favorites[i].accessCount").intValue
        iconColor = jResp.string(of: "favorites[i].iconColor")
        iconUrl = jResp.string(of: "favorites[i].iconUrl")
        id = jResp.string(of: "favorites[i].id")
        lastAccessDate = jResp.string(of: "favorites[i].lastAccessDate")
        name = jResp.string(of: "favorites[i].name")
        objectType = jResp.string(of: "favorites[i].objectType")
        sortOrder = jResp.int(of: "favorites[i].sortOrder").intValue
        subtitle = jResp.string(of: "favorites[i].subtitle")
        target = jResp.string(of: "favorites[i].target")
        targetType = jResp.string(of: "favorites[i].targetType")
        i = i + 1
    }


}

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