获取共享记录详情
在Zoho CRM中,有不同级别的数据共享。记录级数据共享是指用户可以与组织中的其他用户共享单个记录。记录可以包含或不包含相关列表进行共享。
目的
获取Zoho CRM中共享记录的详细信息。
端点
- GET /{module_API_name}/{record_ID}/actions/share
请求详情
请求URL
{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/share
支持的模块
潜在客户,Account,联系人,交易,活动,案例,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,以及自定义模块。
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.分享.{module_name}.{operation_type}
可能的模块名称
线索、账户、联系人、交易、活动、案例、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票和自定义。
可能的操作类型
全部 - 完全访问记录
读取 - 获取共享记录的详细信息
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/3652397000000649013/actions/share"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"参数
- sharedTo string,optional
传递当前用户的ID,以了解与当前用户共享的记录的ID和模块等详细信息。
- view string,optional
表示您想要检索的共享记录的详细信息。
可能的值:摘要
带有 sharedTo 参数的示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/3652397000000649013/actions/share?view=summary&sharedTo=4150868000001199001"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"注意
- 响应内容会根据与记录共享的用户的访问权限而有所不同。如果用户已经通过角色、区域、数据共享、用户查找字段对共享记录拥有完全权限,响应将包含表示与之共享记录的用户的 "user" 键。
- 结果根据以下标准按顺序排序:
- 记录共享的顺序。例如,如果记录先共享给用户A,然后共享给用户B,在结果中,用户B的详细信息将首先显示。
- 记录是单独共享还是与相关列表一起共享。单独共享的记录优先级更高。
- 给用户的权限。优先级顺序从高到低依次为:完全访问、读写、只读。
- 记录共享的时间。优先级顺序从最早到最新。
当用户仅通过记录级共享获得访问权限时的示例响应
Copied{
"share": [
{
"shared_with": {
"name": “Jane Smith",
"id": "3652397000000281001",
"type": "users",
"zuid": "679952958"
},
"share_related_records": true,
"shared_through": {
"module": {
"name": "Contacts",
"id": "3652397000000002179"
},
"id": "3652397000000649013"
},
"permission": "full_access",
"type": "private"
}
]
}可能的错误
- INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP GET 方法来进行此 API 调用。任何其他请求方法都会导致此错误。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限进行读取。
解决方法:联系您的系统管理员。 - INVALID_DATAHTTP 400
- 在URL中给定的记录ID无效或不属于提到的模块。
解决方法:指定一个有效的记录ID。 - 调度程序正在运行。
解决方法:该记录当前正在被共享或撤销。
- 在URL中给定的记录ID无效或不属于提到的模块。
- INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方法:请参阅上面的支持的模块部分,并指定有效的模块 API 名称。 - PATTERN_NOT_MATCHEDHTTP 400
请检查输入值是否正确
解决方法: 'view' 参数中指定的值不正确。请参阅上面的参数部分并指定有效输入。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于进行此 API 调用的访问令牌不具有所需的范围。
解决方案:生成一个具有此 API 所需范围的新访问令牌。请参阅本页开头的范围部分以获取所需范围的列表。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。 - NO_PERMISSIONHTTP 403
没有权限读取
解决方法: 联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方法:请联系支持团队,邮箱:support@zohocrm.com。
用户已经拥有访问该记录的全部权限时的示例响应
Copied{
"share": [
{
"shared_with": {
"name": “Jane Smith“,
"id": "3652397000000281001",
"type": "users",
"zuid": "679952958"
},
"share_related_records": true,
"shared_through": {
"module": {
"name": "Contacts",
"id": "3652397000000002179"
},
"name": "Patricia",
"id": "3652397000000649013"
},
"shared_time": "2022-03-01T11:25:28+05:30",
"permission": "full_access",
"shared_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017",
"zuid": "678521418"
},
"type": "private"
}
]
}