数据共享规则摘要过滤器
目的
获取模块化数据,包括过滤数据集的数据共享规则的数量和运行状态
Request 详情
Request URL
{api-domain}/crm/{version}/settings/data_sharing/rules/actions/summary
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.data_sharing.READ
支持的模块
潜在客户,账户,联系人,交易,任务,会议,电话,产品,供应商,价格书,报价,销售订单,采购订单,发票,和自定义模块
样本请求
输入 JSON
- group_operator string,optional指定如何组合过滤条件(例如,“和”,“或”)。
- group array, optional包含单个过滤条件。
- field JSON object, mandatory代表被过滤的字段。
- api_name string, mandatory代表字段的API名称
- value string or array, mandatory要进行比较的值。
- comparator string, mandatory比较运算符(例如,“等于”,“在”)。
下表列出了键及其对应的运算符:
| 键 | 运算符 |
|---|---|
| superiors_allowed | 等于 |
| status | 等于 |
| shared_to.type | 等于 |
| shared_to.resource.id | 在...之内 |
| shared_from.type | 等于 |
| shared_to.resource.id | 在...之内 |
| name | 类似 |
| permission_type | 等于 |
样本过滤器
Response JSON
- 模块 JSON 对象代表API名称和模块的唯一标识符。
- rule_computation_status 布尔值表示规则当前是否对模块的记录处于运行状态
可能的值:
true
false - rule_count 整数表示为模块配置的共享规则的数量。
可能的错误
- INVALID_DATA HTTP 400
- 超过了分享规则数量的最大长度。
解决方案: 一次只能创建一个分享规则。尝试创建一个分享规则。 - 给出了无效的条件
解决方案: 指定有效的条件。参考输入 JSON部分以获取更多详情。 - 在过滤器 JSON 数组中给出了无效的数据
解决方案: 在"filters" JSON 数组中指定有效的值。参考上述输入 JSON和表格部分以获取更多详情。 - 在字段 JSON 对象中给出了无效的数据
解决方案: 在"field" JSON 对象中指定有效的值。参考输入 JSON部分以获取更多详情。 - 给出了无效的比较器
解决方案: 在输入体中指定有效的比较器。参考输入 JSON部分以获取更多详情。 - 在"group_operator" 键中给出了无效的值
解决方案: 指定一个有效的值。支持的值有 "AND","OR"。
- 超过了分享规则数量的最大长度。
- MANDATORY_NOT_FOUNDHTTP 400
一个或多个必需的键缺失
解决方案:指定所有必需的键。参考输入JSON部分以了解必需的字段。 - DEPENDENT_FIELD_MISSINGHTTP 400
一个或多个依赖字段缺失
解决方案:检查输入JSON部分,以避免缺失依赖字段。 - EXPECTED_FIELD_MISSINGHTTP 400
"filters" JSON数组为空
解决方案:在"filters" JSON数组中至少指定一个过滤器。 - NOT_ALLOWED HTTP 400
状态键不应在输入JSON中传递。
解决方案: 提供一个有效的输入JSON,不包含状态键。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用来进行此API调用的访问令牌没有所需的范围。
解决方案: 生成一个具有此API所需范围的新访问令牌。请参考本页开头的范围部分,查看所需范围的列表。 - NO_PERMISSIONHTTP 403
您没有模块定制权限。
解决方案:获取模块定制的权限。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方案:指定一个有效的请求URL。请参考本页开头的URL部分以获取更多详细信息。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方案:联系支持团队,邮箱为support@zohocrm.com。