使用外部ID获取记录
目的
使用外部ID获取模块中的记录。
端点
- GET /{module_API_name}/{external_field_value}
Request 详细信息
Request URL
通过外部字段值获取:
{api-domain}/crm/{version}/{module_API_name}/{external_field_value}
支持的模块
潜在客户,账户,联系人,交易,活动,任务,案例,会议,电话,解决方案,产品,供应商,价格书,报价,销售订单,采购订单,发票,自定义,预约,服务和活动
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
X-外部:{module_API_name}.{external_field_API_name}
范围
ZohoCRM.modules.ALL
(或者)
ZohoCRM.modules.{module_api_name}.{operation_type}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,案例,事件,呼叫,解决方案,产品,供应商,价格_书,报价,销售_订单,采购_订单,发票,预约__s,服务__s和自定义
可能的操作类型
ALL - 对记录的完全访问
READ - 从模块获取记录
参数
- fields字符串,可选
指定要包含在响应中的字段的API名称。您可以列出多个字段API名称,用逗号分隔。
样本请求
通过外部字段的值获取记录
在这个例子中,Contacts是基础模块的API名称,External_Contact_ID是外部字段的API名称,而externalcontact1是此Contacts模块中记录的此外部字段的值。
样本请求
样本回应
使用 "ids" 参数获取记录
在这个例子中,Contacts 是基础模块的 API 名称,External_Contact_ID 是外部字段的 API 名称。使用 "ids" 参数的请求会检索到具有 externalcontact1 和 externalcontact2 外部值的记录。
样本请求
可能的错误
- NO_CONTENTHTTP 204
指定的ID没有数据,或者在给定的模块中没有匹配的记录。
解决方案:使用给定的外部值创建一条记录,或者尝试使用有效的外部ID再次尝试。 - INVALID_DATAHTTP 400
您在头部指定了无效的外部字段。
解决方案:为X-EXTERNAL头部指定一个有效的外部字段。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用来进行此API调用的访问令牌没有所需的范围。
解决方案:生成具有此API所需范围的新访问令牌。请参阅此页面开头的范围部分,以获取所需范围的列表。 - AUTHENTICATION_FAILUREHTTP 401
您未使用有效的访问令牌授权API调用。
解决方案:在请求头中包含有效的访问令牌以授权API调用。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确,或者您在请求中遗漏了X-EXTERNAL头。
解决方案:使用给定的外部值创建记录,或者尝试使用有效的外部ID再次尝试。
确保在请求中包含X-EXTERNAL头,然后再试一次。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方案:联系支持团队support@zohocrm.com。
注意
- 您不能根据其他用户设置的外部字段值获取记录。
- 在获取记录列表(无外部ID)中支持所有参数。