子表单 API
子表单是一个辅助表单或表格,它允许你在主表单中添加多个明细项。你可以将多个项目关联到一条记录。从技术角度来看,子表单能够轻松解决你在CRM数据中建立一对多关系的需求,即多个辅助项目关联到一个主记录。
注意
获取子表单数据
目的
获取一条记录的子表单数据。
端点
- GET /{module_API_name}/{record_ID}
- GET /{subform_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/{module_API_name}/{record_ID}
(或)
{api-domain}/crm/{version}/{subform_API_name}
支持的模块
潜在客户,Account,联系人,商机,活动,案例,解决方案,产品,Vendors,报价单,Sales Orders,采购Orders,Invoices以及自定义模块。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.模块.{module_name}.{operation_type}
可能的模块名称
线索、账户、联系人、交易、活动、案例、解决方案、产品、供应商、报价、销售订单、采购订单、发票和自定义。
可能的操作类型
ALL - 完全访问记录
READ - 获取模块中的记录
参数
- fields字符串,若使用子表单的 API 名称时必填
指定你希望在响应中获取详情的字段 API 名称。请注意,此参数最多可包含 50 个字段 API 名称。
可选值:多个字段 API 名称,使用逗号分隔。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/554023000000298003"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/Contacts/554023000000298003"
type: GET
connection:"crm_oauth_connection"
];
info response;可能的错误
- INVALID_MODULEHTTP 400
您指定了无效的模块 API 名称,或者没有标签权限,亦或该模块已从可用模块列表中移除。
解决方法:请使用 模块 API 获取模块的 API 名称。如果您没有标签权限或模块已被移除,请联系您的系统管理员。 - INVALID_MODULEHTTP 400
所提供的模块在 API 中不受支持。
解决方法: 诸如“文档”和“项目”等模块目前在 API 中不受支持。一旦这些模块被支持,该错误将不再显示。 - INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:请使用 HTTP GET 方法调用此 API。使用其他请求方法将导致此错误。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于此 API 调用的访问令牌不具备所需的权限范围。
解决方法:生成一个带有 ZohoCRM.modules.{module_name}.{operation_type} 权限范围的新访问令牌。请参阅可能的模块名称和可能的操作类型部分获取详细信息。 - AUTHENTICATION_FAILUREHTTP 401
您未使用有效的访问令牌对 API 调用进行身份验证。
解决方法: 在请求头中包含有效的访问令牌,以对 API 调用进行身份验证。 - NO_PERMISSIONHTTP 403
您没有权限获取子表单的详细信息。
解决方法:请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定有效的请求URL。请参阅请求URL部分以获取正确的URL。 - INTERNAL_ERRORHTTP 500
服务器出现了意外且未处理的异常。
解决方法:请联系支持团队:support@zohocrm.com。
示例回应
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "554023000000235011"
},
"Email": null,
"$currency_symbol": "Rs.",
"Other_Phone": null,
"Mailing_State": null,
"Other_State": null,
"Languages": [
{
"Proficiency": "Professional",
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"$currency_symbol": "Rs.",
"$process_flow": false,
"Languages_Known": "English",
"Parent_Id": {
"name": "Last_Name1",
"id": "554023000000298003"
},
"$editable": true,
"id": "554023000000473001",
"$approved": true
},
{
"Proficiency": "Native",
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"$currency_symbol": "Rs.",
"$process_flow": false,
"Languages_Known": "French",
"Parent_Id": {
"name": "Last_Name1",
"id": "554023000000298003"
},
"$editable": true,
"id": "554023000000473003",
"$approved": true
}
],
"Date_created": "2019-03-04",
"Other_Country": null,
"Last_Activity_Time": "2019-04-22T11:27:23+05:30",
"Department": null,
"$process_flow": false,
"Assistant": null,
"Mailing_Country": null,
"id": "554023000000298003",
"$approved": true,
"Reporting_To": null,
"$approval": {
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Other_City": null,
"Created_Time": "2019-03-04T11:51:53+05:30",
"$editable": true,
"No_of_Employees": null,
"Home_Phone": null,
"Created_By": {
"name": "Patricia Boyle",
"id": "554023000000235011"
},
"Secondary_Email": null,
"Description": null,
"Vendor_Name": null,
"Mailing_Zip": null,
"Twitter": null,
"Other_Zip": null,
"Mailing_Street": null,
"Salutation": null,
"First_Name": null,
"Asst_Phone": null,
"Full_Name": "Last_Name1",
"Record_Image": null,
"Modified_By": {
"name": "Patricia Boyle",
"id": "554023000000235011"
},
"Skype_ID": null,
"Phone": null,
"Account_Name": null,
"Email_Opt_Out": false,
"Modified_Time": "2019-04-22T11:27:23+05:30",
"Date_of_Birth": null,
"Mailing_City": null,
"Title": null,
"Other_Street": null,
"Mobile": null,
"Territories": [],
"Last_Name": "Last_Name1",
"Lead_Source": "Advertisement",
"Tag": [],
"Fax": null
}
]
}在本回答中,“Languages”是联系人模块中的一个子表单,包含两个下拉选择字段:“Languages_Known”(已掌握语言)和“Proficiency”(熟练程度)。