创建数据共享规则
目的
要创建一条数据共享规则,以将对CRM记录的访问权限扩展到其他角色和组中的用户,或扩展到您Zoho CRM组织中的所有用户。
注意
您可以使用此 API 一次创建一条数据共享规则。
端点
- POST /settings/data_sharing/rules?module={module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/data_sharing/rules?module={module_API_name}
可能的模块名称
线索, 联系人, Accounts, 商机, 任务, 事件, 通话, 产品, 报价单, Sales_Orders, 采购_Orders, Invoices, 市场活动, Vendors, 价目表, 案例, 解决方案
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.data_sharing.create
支持的模块
线索, Accounts, 联系人, 交易, 任务, 会议, 通话, 产品, Vendors, 价目表, 报价单, Sales Orders, 采购 Orders, Invoices, 和 自定义模块
参数
- module字符串,必填
指定要为其创建数据共享规则的模块,例如 Leads 或 Contacts。您可以使用 GET - 模块元数据 API 来获取模块 API 名称。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/data_sharing/rules?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @createsharingrules.json
-X POST输入 JSON
- 名称 字符串,必填表示共享规则的名称。
- superiors_allowed 布尔值,必填指示与其共享记录的特定角色或群组的上级是否被允许访问这些记录。
可能的取值:
true- 允许上级访问
false- 不允许上级访问 - 类型 字符串,必填指定共享规则的类型。共享规则可以基于记录所有者或基于要共享记录的特定条件。
可选值:
Record_Owner_Based- 数据共享基于记录所有者
Criteria_Based- 数据共享基于条件。 - shared_to JSON 对象,必填
表示数据共享目标资源的详细信息。数据可以共享给角色、角色及其下属、群组或所有用户。
- 资源JSON 对象
表示数据被共享到的资源。它由资源的唯一标识符组成。
- 类型 字符串指定数据共享到的资源类型。 可能的取值:
roles- 如果 subordinates 键为 false,则记录共享给角色;如果 subordinates 键为 true,则记录共享给角色及其下属。
groups- 记录共享给群组
all_users- 记录共享给所有用户。 - subordinatesboolean当 "type" 设置为 roles 时,表示是否与下属共享记录。
可能的值:
true- 包含下属。
false- 不包含下属。
键 "type" 和 "subordinates" 共同表示数据共享的这些可能性(角色、角色及其下属、所有用户或组),如下所示。
数据共享的目标资源 类型 下属 群组 groups 否 Role Role 否 Role及其下属 Role 是 所有用户 all_users 否 - shared_from JSON 对象,当类型为 Record_Owner_Based 时为必需
表示其数据被共享的资源的详细信息。当数据共享类型为基于记录所有者时,这些详细信息可用。数据可以从角色、角色及其下属或群组进行共享。
- resourceJSON 对象
表示其数据被共享的资源。它由该资源的唯一标识符组成。
- 类型 字符串表示其数据被共享的资源类型。数据可以从角色、角色及其下属,或群组进行共享。 可能的取值:
roles- 如果 subordinates 键为 false,则记录从角色共享;如果 subordinates 键为 true,则记录从角色及其下属共享。
groups- 记录将共享给群组。 - subordinates boolean用于指示当 "type" 键为 roles 时是否包含下属。
可能的值:
true- 包含下属。
false- 不包含下属。
键 "type" 和 "subordinate"s 一起表示可共享数据的不同资源类型(例如,角色、角色及下属或群组),如下所述。
数据共享到的资源 类型 下属 群组 群组 否 Role Role 否 Role 和下属 Role 是 - criteria JSON 对象,当类型为 Criteria_Based 时为必填
表示共享记录的条件。当数据共享类型为基于条件时,应提供这些详细信息。
- group_operator 字符串
指定在条件中使用的分组运算符。
- group JSON 数组
表示用于筛选记录的条件组。
- fieldJSON 对象
表示该字段的 API 名称。
- comparator字符串
表示该条件中使用的比较运算符。
- value字符串
表示该条件中使用的值。
- permission_type 字符串,必填指定授予的权限或访问类型。可能的取值:
read- 只读。
read_write- 读取/写入。
read_write_delete- 读取/写入/删除。
注意
通过 API 创建的数据共享规则会自动被赋予 "active" 状态。请不要在输入 JSON 中包含 "status" 键。在输入 JSON 中包含 "status" 键将导致错误。
基于记录所有者的共享规则示例输入
Copied{
"sharing_rules": [
{
"name": "Lead sharing rule",
"superiors_allowed": false,
"type": "Record_Owner_Based",
"shared_to": {
"resource": {
"id": "3602353000000015966"
},
"type": "roles",
"subordinates": false
},
"shared_from": {
"resource": {
"id": "3602353000000015969"
},
"type": "roles",
"subordinates": true
},
"permission_type": "read_write_delete"
}
]
}基于条件的共享规则的示例输入
Copied{
"sharing_rules": [
{
"superiors_allowed": false,
"type": "Criteria_Based",
"criteria": {
"group_operator": "AND",
"group": [
{
"comparator": "equal",
"field": {
"api_name": "City"
},
"type": "value",
"value": "Miami"
},
{
"comparator": "equal",
"field": {
"api_name": "State"
},
"type": "value",
"value": "Florida"
}
]
},
"shared_to": {
"resource": {
"name": "Miami Users",
"id": "3602353000000601002"
},
"type": "groups",
"subordinates": false
},
"shared_from": null,
"permission_type": "read_write_delete",
"name": "Lead Sharing Rule for Chennai "
}
]
}可能的错误
- INVALID_DATA HTTP 400
共享规则数量已超出最大限制。
解决方法:您一次只能创建一个共享规则。请尝试仅创建一个共享规则。 - INVALID_DATA HTTP 400
提供的 api_name 似乎无效
解决方案: 请为条件中提到的字段提供正确的 API 名称。 - DUPLICATE_DATA HTTP 400
已存在同名的共享规则。
解决方案:请尝试使用不同的名称创建共享规则。 - DEPENDENT_FIELD_MISMATCH HTTP 400
输入 JSON 中提供的资源类型和 ID 不匹配。
解决方案:提供有效的资源类型和 ID 的组合。 - NOT_ALLOWED HTTP 400
Status 键不应在输入 JSON 中传递。
解决方案:请提供不包含 Status 键的有效输入 JSON。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于进行此 API 调用的访问令牌不具备所需的作用域。
解决方法:为此 API 生成具有所需作用域的新访问令牌。有关所需作用域的列表,请参阅本页开头的作用域部分。 - NO_PERMISSIONHTTP 403
您没有模块自定义权限。
解决方案:获取模块自定义权限。 - INVALID_URL_PATTERNHTTP 404
请求 URL 不正确。
解决方法: 指定有效的请求 URL。有关详细信息,请参阅本页开头的请求 URL 部分。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方法:联系支持团队:support@zohocrm.com。
示例响应
Copied{
"sharing_rules": [
{
"code": "SUCCESS",
"details": {
"id": "3602353000000608035"
},
"message": "sharing rule is created successfully",
"status": "success"
}
]
}