Zoho crm Logo

数据共享规则摘要

目的

要获取您的Zoho CRM组织中按模块划分的共享规则数量及运行状态数据。

请求详情

请求 URL

{api-domain}/crm/{version}/settings/data_sharing/rules/actions/summary

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.设置.数据_共享.读取

支持的模块

潜在客户, Accounts, 联系人, 交易, 任务, 会议, 通话, 产品, Vendors, 价目表, 报价单, Sales Orders, 采购 Orders, Invoices, 和自定义模块

请求示例

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/data_sharing/rules/actions/summary"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

响应 JSON

  • module JSON object
    表示模块的 API 名称和唯一标识符。
  • rule_computation_status Boolean
    指示该规则当前是否正在针对该模块的记录运行
    可能的值:
    true
    false
  • rule_count integer
    表示为该模块配置的共享规则数量。

可能的错误

  • 无内容HTTP 204

    当共享规则不存在时。

  • 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_summary": [
        {
            "module": {
                "api_name": "Leads",
                "id": "3602353000000000125"
            },
            "rule_computation_status": true,
            "rule_count": 5
        },
        {
            "module": {
                "api_name": "Contacts",
                "id": "3602353000000000129"
            },
            "rule_computation_status": false,
            "rule_count": 1
        },
        {
            "module": {
                "api_name": "Accounts",
                "id": "3602353000000000127"
            },
            "rule_computation_status": false,
            "rule_count": 1
        },
        {
            "module": {
                "api_name": "Deals",
                "id": "3602353000000000131"
            },
            "rule_computation_status": false,
            "rule_count": 1
        },
        {
            "module": {
                "api_name": "Tasks",
                "id": "3602353000000000143"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Events",
                "id": "3602353000000000145"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Calls",
                "id": "3602353000000017015"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Products",
                "id": "3602353000000000163"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Quotes",
                "id": "3602353000000000169"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Sales_Orders",
                "id": "3602353000000000171"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Purchase_Orders",
                "id": "3602353000000000173"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Invoices",
                "id": "3602353000000000175"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Campaigns",
                "id": "3602353000000000133"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Vendors",
                "id": "3602353000000000165"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Price_Books",
                "id": "3602353000000000167"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Cases",
                "id": "3602353000000000159"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Solutions",
                "id": "3602353000000000161"
            },
            "rule_computation_status": false,
            "rule_count": 0
        }
    ]
}