更新数据共享规则
目的
要更新在您的ZohoCRM组织中配置的数据共享规则。
注意
您可以使用此 API 一次更新一条数据共享规则。
端点
- PUT /settings/data_sharing/rules?module={module_API_name}
- PUT /settings/data_sharing/rules/{rules_ID}?module={module_API_name}
请求详情
请求 URL
要更新单个数据共享规则:
{api-domain}/crm/{version}/settings/data_sharing/rules?module={module_API_name}
{api-domain}/crm/{version}/settings/data_sharing/rules/{rules_ID}?module={module_API_name}
可能的模块名称
潜在客户、联系人、Account、交易、任务、活动、电话、产品、报价、Sales_Orders、采购_Orders、Invoices、营销活动、Vendors、价格表、案件、解决方案
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.设置.数据共享.更新
支持的模块
线索,Account,联系人,商机,任务,会议,电话,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,以及自定义模块
参数
- module 字符串,必填
指定你想要更新数据共享规则的模块,例如线索或联系人。你可以使用获取 - 模块元数据 API来获取模块的 API 名称。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/data_sharing/rules?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @updatesharingrules.json
-X PUT输入 JSON
- 名称 字符串, 可选表示共享规则的名称。
- id 字符串,可选表示共享规则的唯一标识符。请参阅获取共享规则 API以获取共享规则的唯一 ID。
- superiors_allowed 布尔值,必填指示与其共享记录的特定角色或群组的上级是否被允许访问这些记录。
可能的值:
true - 允许上级访问
false - 不允许上级访问 - 类型 字符串,必填指定共享规则的类型。共享规则可以基于记录所有者,或基于要共享记录的特定条件。
可能的取值:
Record_Owner_Based(基于记录所有者) - 数据共享基于记录所有者
Criteria_Based(基于条件) - 数据共享基于特定条件。 - shared_to JSON 对象,必填
表示数据共享目标资源的详细信息。数据可以共享给角色、角色及其下属、群组或所有用户。
- 资源JSON 对象
表示数据所共享的资源。它由资源的唯一标识符组成。
- 类型 字符串指定数据共享到的资源类型。可能的取值:
roles - 如果 subordinates 键为 false,则记录共享给角色。如果 subordinates 键为 true,则记录共享给角色及其下属。
groups - 记录共享给组
all_users - 记录共享给所有用户。 - 下属布尔值当“type”设置为角色时,指示记录是否与下属共享。
可能的取值:
true - 包含下属。
false - 不包含下属。
“type”和“subordinates”这两个键共同表示如下的数据共享可能性(角色、角色及下属、所有用户或群组)。
数据共享到的资源 类型 下属 群组 群组 否 Role Role 否 Role和下属 Role 是 所有用户 所有用户 否 - shared_from JSON 对象,当类型为 Record_Owner_Based 时为必填项
表示其数据被共享的资源的详细信息。当数据共享类型为基于记录所有者时,这些详细信息可用。数据可以通过角色、角色及其下属或群组进行共享。
- resourceJSON 对象
表示被共享数据的资源。它包含资源的唯一标识符。
- type string表示共享其数据的资源类型。数据可以从角色、角色及其下属或组中共享。可能的值:
roles - 如果 subordinates 键为 false,则记录是从角色共享的。如果 subordinates 键为 true,则记录是从角色及其下属共享的。
groups - 记录被共享到组。 - 下属 布尔值当 "type" 键为角色时,指示是否包含下属。
可能的值:
true - 包含下属。
false - 不包含下属。
“type”和“subordinate”两个键共同表示可共享数据的不同资源类型(例如,角色、角色及其下属,或群组),具体说明如下。
共享数据的资源 类型 下属 群组 群组 否 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 不支持更新状态键。
示例输入
Copied{
"sharing_rules": [
{
"superiors_allowed": false,
"type": "Record_Owner_Based",
"shared_to": {
"resource": {
"name": "CEO",
"id": "3602353000000015966"
},
"type": "roles",
"subordinates": false
},
"shared_from": {
"resource": {
"name": "Manager",
"id": "3602353000000015969"
},
"type": "roles",
"subordinates": true
},
"permission_type": "read_write_delete",
"id": "3602353000000608003"
}
]
}可能的错误
- INVALID_DATA HTTP 400
共享规则数量已超过最大长度。
解决方法:您一次只能创建一个共享规则。请尝试只创建一个共享规则。 - INVALID_DATA HTTP 400
提供的 api_name 似乎无效
解决方法:请为条件中提到的字段提供正确的 API 名称。 - DUPLICATE_DATA HTTP 400
具有相同名称的共享规则已存在。
解决方法:请尝试使用不同的名称创建共享规则。 - DEPENDENT_FIELD_MISMATCH HTTP 400
输入中的资源类型和ID在JSON中不匹配。
解决方法:请提供有效的资源类型和ID组合。 - NOT_ALLOWED HTTP 400
输入的Status键不应被传递到JSON中。
解决方法:请提供不含有Status键的有效输入JSON。 - 无法处理HTTP 400
共享规则正在计算中。请稍后再试。
解决方法:您正在尝试更新的数据共享规则当前处于计算流程中。只有在该流程执行完成后,您才能进行更新。请稍后再试。 - 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": "3602353000000608003"
},
"message": "sharing rule is updated successfully",
"status": "success"
}
]
}