Chilkat Online Tools

Ruby / Zoho CRM REST APIs / Custom

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()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("module","{{Custom_module_API_name}}")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/crm/v2/settings/layouts",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

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

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/layouts?module={{Custom_module_API_name}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "settings",
        "layouts"
      ],
      "query": [
        {
          "key": "module",
          "value": "{{Custom_module_API_name}}"
        }
      ]
    },
    "description": "To get the metadata of the custom module."
  },
  "response": [
  ]
}