Chilkat Online Tools

Ruby / Zoho CRM REST APIs / Using the external value and the "in" operator in "criteria"

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("criteria","(External_Contact_ID:in:usercontact2,usercontact123)")
queryParams.UpdateString("fields","External_Contact_ID,Email")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("X-EXTERNAL","Contacts.External_Contact_ID")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/crm/v2/Contacts/search",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 "criteria=%28External_Contact_ID%3Ain%3Ausercontact2,usercontact123%29"
	-d "fields=External_Contact_ID,Email"
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_Contact_ID"
https://domain.com/crm/v2/Contacts/search

Postman Collection Item JSON

{
  "name": "Using the external value and the \"in\" operator in \"criteria\"",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Contacts.External_Contact_ID",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts/search?criteria=(External_Contact_ID:in:usercontact2,usercontact123)&fields=External_Contact_ID,Email",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "search"
      ],
      "query": [
        {
          "key": "criteria",
          "value": "(External_Contact_ID:in:usercontact2,usercontact123)"
        },
        {
          "key": "fields",
          "value": "External_Contact_ID,Email"
        }
      ]
    },
    "description": "Parameter:criteria=(External_Contact_ID:in:usercontact2,usercontact123)"
  },
  "response": [
  ]
}