Zoho crm Logo

记录锁定配置APIs

记录锁定配置允许您设置所需的配置,以在满足某些条件时手动或自动锁定模块中的记录。

GET 获取记录锁定配置

目的

检索不同模块的记录锁定配置。

端点

  • GET /settings/record_locking_configurations?module={module_API_name}

请求详情

Request URL

{api-domain}/crm/{version}/settings/record_locking_configurations?module={module_API_name}

支持的模块

潜在客户,联系人,账户,交易,报价,销售订单,采购订单,发票,供应商,价格书,案例,解决方案,任务,产品和自定义模块

注意

  • 对于自定义模块,只有用户创建的模块才支持记录锁定。通过扩展、集成或其他方式创建的自定义模块不受支持。

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.record_locking_configurations.Read
(或者)
ZohoCRM.settings.record_locking_configurations.ALL

样本请求

参数
  • module字符串,必填

    指定所需模块的API名称,以检索与该模块相关的记录锁定配置。

  • feature_type字符串,可选

    使用此参数过滤所需的记录锁定配置。
    可能的值: record_locking

Response JSON

  • created_time string

    表示创建记录锁定配置的日期和时间。

  • locked_for 字符串

    表示记录是否对所有配置文件进行了锁定,或者对除少数例外的所有配置文件进行了锁定。
    可能的值: all_profiles_except_excluded_profile, all_profiles

  • excluded_fieldsJSON 数组

    代表从记录锁定中排除的字段

    • api_name字符串

      代表从记录锁定中排除的字段的API名称。

    • id 长整型

      代表从记录锁定中排除的字段的ID。

  • created_byJSON 对象

    代表创建记录锁定配置的用户的名称和ID。

    • name 字符串

      代表创建记录锁定配置的用户的名称。

    • id长整型

      代表创建记录锁定配置的用户的ID。

  • feature_typestring

    代表记录锁定配置的特性类型。

  • 锁定规则 JSON 数组

    代表自动在模块中锁定记录的规则详情。

    • 名称字符串

      代表记录锁定规则的名称

    • idlong

      代表记录锁定规则的ID。

    • lock_existing_recordsboolean

      指示是否必须锁定现有记录。

    • criteriaJSON Object

      指定记录锁定规则的标准。

      • group_operator字符串

        指定在条件中使用的组操作符。
        可能的值:AND,OR

      • groupJSON 数组

        代表记录锁定规则的条件组。

        • comparator字符串

          代表在条件中使用的比较运算符。

        • fieldJSON 对象

          代表条件的字段详细信息。

          • api_name字符串

            指定字段的API名称。

          • id长整型

            指定字段的ID。

        • value字符串

          指定在条件中使用的值。

  • restricted_actionsJSON 数组

    指定了对锁定记录的限制操作。

  • lock_for_portal_usersboolean

    指示是否也为门户用户限制锁定的记录。

  • modified_timestring

    表示修改记录锁定配置的日期和时间。

  • restricted_communicationsJSON 数组

    指定对锁定记录进行限制的通信类型。

  • system_defined布尔值

    指示记录配置是否由系统定义。

  • modified_byJSON 对象

    代表修改记录锁定配置的用户的名称和ID。

    • name 字符串

      代表修改记录锁定配置的用户的名称

    • id长整型

      代表修改记录锁定配置的用户的ID。

  • lock_type字符串

    代表记录锁定配置的类型。
    可能的值: 手动,自动,两者皆有
    当锁定类型为自动时,当满足锁定条件时,记录将自动被锁定。当锁定类型为手动时,具有其配置文件中锁定权限的用户可以手动锁定记录。

  • restricted_custom_buttonsJSON Array

    代表被限制用于锁定记录的自定义按钮。

    • name string

      代表被限制用于锁定记录的自定义按钮的API名称。

    • id long

      代表被限制用于锁定记录的自定义按钮的ID。

  • lock_excluded_profilesJSON Array

    代表被限制锁定的配置文件。

    • api_name string

      代表被限制锁定的配置文件的API名称。

    • id long

      代表被限制锁定的配置文件的ID。

可能的错误

  • NO_CONTENTHTTP 204

    您的组织中没有配置记录锁定配置。
    解决方案:在您的组织中配置记录锁定配置。

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少预期的参数之一。
    解决方案:响应中的 "details" 键提供了请求中缺少的参数。确保在 "Parameters" 部分中包含标记为 "mandatory" 的参数。

  • INVALID_MODULEHTTP 400

    给出的模块名称似乎无效。
    解决方案:指定一个有效的模块API名称。

  • NOT_SUPPORTEDHTTP 400

    给出的模块名称不支持此功能。
    解决方案:指定一个受支持的模块API名称。

  • INVALID_DATAHTTP 400

    给出的id似乎无效。
    解决方案:指定一个有效的记录配置id。

  • FEATURE_NOT_SUPPORTEDHTTP 400

    您的版本不支持记录锁定配置。
    解决方案:联系您的管理员。

  • INVALID_REQUEST_METHODHTTP 403

    HTTP请求方法类型无效。
    解决方案: 您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考页面开头的端点部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误。
    解决方案:服务器中出现意外且未处理的异常。请联系支持团队。

样本回应