Zoho crm Logo

搜索数据共享规则 API

目的

要从您的CRM中检索符合特定条件的数据共享规则,可以按状态、共享到的角色或组、权限类型和其他关键细节等属性进行筛选。

请求详情

请求 URL

{api-domain}/crm/{version}/settings/data_sharing/rules/search

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.data_sharing.READ

支持的模块

潜在客户,Account,联系人,交易,任务,会议,电话,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,以及自定义模块

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/data_sharing/rules/search"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @searchdatasharingrules.json
-X POST

输入 JSON

  • group_operator 字符串,当在请求的组键中指定多个条件时是必需的
    指定如何组合过滤条件。
    可能的值:
    and - 该操作符组合不同组的过滤条件,使得必须满足所有条件才能将记录包含在结果中。
    or - 该操作符组合过滤条件组,使得只需满足其中一个条件即可将记录包含在结果中。
  • group array, optional
    包含单个过滤条件。
    • field JSON object, mandatory
      表示被过滤的字段。
      • api_name 字符串,必填
        表示字段的 API 名称。
    • value string or array, mandatory
      要比较的值。
    • comparator string, mandatory
      比较运算符。 
      可能的值:equal, in, like。
       

下表列出了键及其对应的操作符:

键操作符
superiors_allowed等于
status等于
shared_to.type等于
shared_to.resource.id在
shared_from.type等于
shared_to.resource.id在
name类似
permission_type等于

示例过滤器

Copied{
    "filters": [
        {
            "group_operator": "and",
            "group": [
                {
                    "group_operator": "or",
                    "group": [
                        {
                            "group_operator": "and",
                            "group": [
                                {
                                    "field": {
                                        "api_name": "shared_to.resource.id"
                                    },
                                    "value": [
                                        "3602353000000601002"
                                    ],
                                    "comparator": "in"
                                },
                                {
                                    "field": {
                                        "api_name": "shared_to.type"
                                    },
                                    "value": "groups",
                                    "comparator": "equal"
                                }
                            ]
                        },
                        {
                            "group_operator": "and",
                            "group": [
                                {
                                    "field": {
                                        "api_name": "shared_to.resource.id"
                                    },
                                    "value": [
                                        "3602353000000015969"
                                    ],
                                    "comparator": "in"
                                },
                                {
                                    "field": {
                                        "api_name": "shared_to.type"
                                    },
                                    "value": "roles",
                                    "comparator": "equal"
                                }
                            ]
                        }
                    ]
                },
                {
                    "field": {
                        "api_name": "status"
                    },
                    "value": "active",
                    "comparator": "equal"
                }
            ]
        }
    ]
}

响应 JSON

  • moduleJSON object

    表示共享规则适用的模块。它由 API 名称、显示标签和模块的唯一标识符组成。

  • superiors_allowedboolean
    指示与特定角色或组共享记录的上级是否被允许访问记录。 
    可能的值:
    true- 允许上级访问
    false- 不允许上级访问
  • typestring
    指定共享规则的类型,可以基于记录所有者或基于要共享记录的特定条件。 
    可能的值:
    Record_Owner_Based- 数据共享基于记录所有者
    Criteria_Based- 数据共享基于条件。
  • shared_toJSON object

    表示数据共享到的资源的详细信息。数据可以共享给角色、角色及其下属、群组或所有用户。

    • resourceJSON object

      表示共享数据的资源。它由资源的名称和唯一标识符组成。

    • type string
      指定共享数据的资源类型。可能的值:
      roles- 如果 subordinates 键为 false,则记录共享给角色。如果 subordinates 键为 true,则记录共享给角色及其下属。
      可能的值:
      groups- 记录共享给组
      all_users- 记录共享给所有用户。
    • subordinatesboolean
      当 "type" 键为 roles 时,指示是否包含下属。
      可能的值:
      true - 包含下属。
      false - 不包含下属。

    “type”和“subordinates”这两个键一起表示数据共享的这些可能性(角色、角色和下属、所有用户或组),如下所示。

    数据共享的资源类型下属
    群组groupsfalse
    RolesRolesfalse
    Roles和下属Rolestrue
    所有用户all_usersfalse
  • shared_from

    表示共享数据的资源详细信息。当数据共享类型基于记录所有者时,这些详细信息可用。数据可以从角色、角色及其下属或组中共享。

    • resourceJSON object

      表示共享数据的资源。它由资源的名称和唯一标识符组成。

    • type string
      表示共享数据的资源类型。数据可以从角色、角色和下属或组中共享。可能的值:
      roles- 如果 subordinates 键为 false,则记录从角色共享。如果 subordinates 键为 true,则记录从角色和下属共享。
      groups- 记录共享到组。
    • subordinates boolean
      指示在 "type" 键为 roles 时是否包含下属。
      可能的值:
      true - 包含下属。
      false - 不包含下属。

    键 "type" 和 "subordinates" 一起表示可以共享数据的不同类型的资源(例如,角色、角色和下属,或组),如下所述。

    数据共享的资源类型下属
    群组groupsfalse
    RolesRolesfalse
    Roles和下属Rolestrue
  • criteria JSON object 

    它表示共享记录的标准。当数据共享类型是基于标准并且获取了特定的数据共享规则时,可以查看这些详细信息。请参阅此处的示例响应,当检索到特定规则时。

    • group_operator string 

      指定在条件中使用的组操作符

    • group JSON array

      它表示用于过滤记录的条件组。

      • fieldJSON object

        它表示字段的 API 名称。

      • comparatorstring

        它表示条件中使用的比较运算符。

      • valuestring

        它表示条件中使用的值。

  • permission_typestring
    指定授予的权限或访问类型。
    可能的值:
    read- 只读
    read_write- 读/写
    read_write_delete- 读/写/删除。
  • namestring
    表示共享规则的名称。
  • idstring
    表示此共享规则的唯一标识符。
  • match_limit_exceeded boolean
    指示规则是否匹配超过了四百万条记录的最大限制。 
    可能的值: 
    true
    false

可能的错误

  • NO CONTENT HTTP 204

    当共享规则不存在时。

  • 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

    Status 键不应在输入 JSON 中传递。
    解决方案: 提供一个有效的输入 JSON,不包含 Status 键。

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方法:使用 HTTP GET 方法来进行此 API 调用。任何其他请求方法都会导致此错误。

  • 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": [
        {
            "module": {
                "api_name": "Leads",
                "name": "Leads",
                "id": "3602353000000000125"
            },
            "superiors_allowed": true,
            "type": "Record_Owner_Based",
            "shared_to": {
                "resource": {
                    "name": "Manager",
                    "id": "3602353000000015969"
                },
                "type": "roles",
                "subordinates": false
            },
            "shared_from": {
                "resource": {
                    "name": "CEO",
                    "id": "3602353000000015966"
                },
                "type": "roles",
                "subordinates": false
            },
            "permission_type": "read_write_delete",
            "name": "Lead Sharing Rules",
            "id": "3602353000000603003",
            "status": "active",
            "match_limit_exceeded": false
        },
        {
            "module": {
                "api_name": "Leads",
                "name": "Leads",
                "id": "3602353000000000125"
            },
            "superiors_allowed": false,
            "type": "Criteria_Based",
            "shared_to": {
                "resource": {
                    "name": "User Group1",
                    "id": "3602353000000601002"
                },
                "type": "groups",
                "subordinates": false
            },
            "shared_from": null,
            "permission_type": "read_write_delete",
            "name": "Deal Sharing Rule 1",
            "id": "3602353000000608013",
            "status": "active",
            "match_limit_exceeded": false
        },
        {
            "module": {
                "api_name": "Leads",
                "name": "Leads",
                "id": "3602353000000000125"
            },
            "superiors_allowed": false,
            "type": "Criteria_Based",
            "shared_to": {
                "resource": {
                    "name": "User Group1",
                    "id": "3602353000000601002"
                },
                "type": "groups",
                "subordinates": false
            },
            "shared_from": null,
            "permission_type": "read_write_delete",
            "name": "Lead Sharing Rule for Chennai",
            "id": "3602353000000608023",
            "status": "active",
            "match_limit_exceeded": false
        },
        {
            "module": {
                "api_name": "Leads",
                "name": "Leads",
                "id": "3602353000000000125"
            },
            "superiors_allowed": false,
            "type": "Criteria_Based",
            "shared_to": {
                "resource": {
                    "name": "User Group1",
                    "id": "3602353000000601002"
                },
                "type": "groups",
                "subordinates": false
            },
            "shared_from": null,
            "permission_type": "read_write_delete",
            "name": "Lead Sharing Rule for Chennai 2",
            "id": "3602353000000608035",
            "status": "active",
            "match_limit_exceeded": false
        },
        {
            "module": {
                "api_name": "Accounts",
                "name": "Accounts",
                "id": "3602353000000000127"
            },
            "superiors_allowed": false,
            "type": "Record_Owner_Based",
            "shared_to": {
                "resource": {
                    "name": "User Group1",
                    "id": "3602353000000601002"
                },
                "type": "groups",
                "subordinates": false
            },
            "shared_from": {
                "resource": {
                    "name": "User Group1",
                    "id": "3602353000000601002"
                },
                "type": "groups",
                "subordinates": false
            },
            "permission_type": "read_write_delete",
            "name": "Accounts sharing rules",
            "id": "3602353000000602055",
            "status": "active",
            "match_limit_exceeded": false
        },
        {
            "module": {
                "api_name": "Deals",
                "name": "Deals",
                "id": "3602353000000000131"
            },
            "superiors_allowed": false,
            "type": "Criteria_Based",
            "shared_to": {
                "resource": {
                    "name": "User Group1",
                    "id": "3602353000000601002"
                },
                "type": "groups",
                "subordinates": false
            },
            "shared_from": null,
            "permission_type": "read_write_delete",
            "name": "Deal Sharing Rule",
            "id": "3602353000000609009",
            "status": "active",
            "match_limit_exceeded": false
        }
    ],
    "info": {
        "per_page": 200,
        "count": 6,
        "page": 1,
        "more_records": false
    }
}