Chilkat Online Tools

Swift3 / Zoho CRM REST APIs / Custom

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

    let queryParams = CkoJsonObject()!
    queryParams.update("module", value: "{{Custom_module_API_name}}")

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

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://domain.com/crm/v2/settings/related_lists", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

Curl Command

curl -G -d "module=%7B%7BCustom_module_API_name%7D%7D"
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/settings/related_lists

Postman Collection Item JSON

{
  "name": "Custom",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2/settings/related_lists?module={{Custom_module_API_name}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "settings",
        "related_lists"
      ],
      "query": [
        {
          "key": "module",
          "value": "{{Custom_module_API_name}}"
        }
      ]
    },
    "description": "To get the metadata of the custom module."
  },
  "response": [
  ]
}