PowerBuilder / Zoho CRM REST APIs / Using External Field's Value
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("fields","External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal")
loo_QueryParams.UpdateInt("per_page",2)
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("X-EXTERNAL","Contacts.External_ID")
loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/crm/v2/Contacts/externalcontact1",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
Curl Command
curl -G -d "fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
-d "per_page=2"
-H "Authorization: Bearer <access_token>"
-H "X-EXTERNAL: Contacts.External_ID"
https://domain.com/crm/v2/Contacts/externalcontact1
Postman Collection Item JSON
{
"name": "Using External Field's Value",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "X-EXTERNAL",
"value": "Contacts.External_ID",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/externalcontact1?fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal&per_page=2",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"externalcontact1"
],
"query": [
{
"key": "fields",
"value": "External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
},
{
"key": "per_page",
"value": "2"
}
]
},
"description": "To fetch a record through the external field's value. In this example, Contacts is the base module's API name, External_Contact_ID is the API name of the external field, and externalcontact1 is the value of the external field in this module."
},
"response": [
]
}