Chilkat Online Tools

Swift / Salesforce Platform APIs / Create a Favorite

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.

    // {
    //   "name": "Favorite Name",
    //   "sortOrder": 1,
    //   "target": "API Name or ID",
    //   "targetType": "ListView | ObjectHome | Record | Tab"
    // }

    let json = CkoJsonObject()
    json.UpdateString("name", value: "Favorite Name")
    json.UpdateInt("sortOrder", value: 1)
    json.UpdateString("target", value: "API Name or ID")
    json.UpdateString("targetType", value: "ListView | ObjectHome | Record | Tab")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"
    http.SetRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/services/data/v{{version}}/ui-api/favorites", contentType: "application/json", json: json)
    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)

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

    var accessCount: Int = jResp.IntOf("accessCount").intValue
    var iconColor: String? = jResp.StringOf("iconColor")
    var iconUrl: String? = jResp.StringOf("iconUrl")
    var id: String? = jResp.StringOf("id")
    var lastAccessDate: String? = jResp.StringOf("lastAccessDate")
    var name: String? = jResp.StringOf("name")
    var objectType: String? = jResp.StringOf("objectType")
    var sortOrder: Int = jResp.IntOf("sortOrder").intValue
    var subtitle: String? = jResp.StringOf("subtitle")
    var target: String? = jResp.StringOf("target")
    var targetType: String? = jResp.StringOf("targetType")

}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "name": "Favorite Name",
    "sortOrder": 1,
    "target": "API Name or ID",
    "targetType": "ListView | ObjectHome | Record | Tab"
}'
https://domain.com/services/data/v{{version}}/ui-api/favorites

Postman Collection Item JSON

{
  "name": "Create a Favorite",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\": \"Favorite Name\",\n    \"sortOrder\": 1,\n    \"target\": \"API Name or ID\",\n    \"targetType\": \"ListView | ObjectHome | Record | Tab\"\n}",
      "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": "Create a Favorite"
  },
  "response": [
    {
      "name": "Create a Favorite list view",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"AllAccountsListView\",\n    \"sortOrder\": 1,\n    \"target\": \"00B58000002ssinEAA\",\n    \"targetType\": \"ListView\"\n}",
          "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": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:03:31 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    \"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}"
    }
  ]
}