添加记录锁定配置
目的
为不同模块添加记录锁定配置。
端点
- POST /settings/record_locking_configurations?module={module_API_name}
Request 详细信息
Request URL
{api-domain}/crm/{version}/settings/record_locking_configurations?module={module_API_name}
支持的模块
潜在客户,联系人,账户,交易,报价,销售订单,采购订单,发票,供应商,价格手册,案例,解决方案,任务,产品和自定义模块
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.record_locking_configurations.Create
样本请求
参数
- 模块字符串,必填
指定您想要添加记录锁定配置的模块的API名称。
注意
- 对于自定义模块,只有用户创建的模块才支持记录锁定。通过扩展、集成或其他方式创建的自定义模块不受支持。
输入 JSON 键
- lock_type字符串,必填
表示记录锁定配置的类型。
可能的值: 手动,自动,两者。
当锁定类型为自动时,如果在创建或更新记录时满足指定的条件,记录将自动被锁定。当锁定类型为手动时,具有其配置文件中锁定权限的用户可以手动锁定记录。 - locking_rules JSON 数组,当 "lock_type" 为 "both" 或 "automatic" 时必填
指定添加到模块中以自动锁定记录的规则的详细信息。
- 名称字符串,当“lock_type”为“both”或“automatic”时必填
指定记录锁定规则的名称。
- lock_existing_records 布尔值,可选
指定是否必须锁定现有记录。
- 条件 JSON 对象,当 "lock_type" 为 "both" 或 "automatic" 时必填
指定记录锁定规则的标准。
- group_operator字符串
指定在条件中使用的组操作符
可能的值: AND,OR - 组 JSON 数组
代表记录锁定规则的条件组。
- 比较器字符串
代表在条件中使用的比较运算符。
- 字段JSON 对象
代表条件的字段详细信息。
- api_name字符串
指定字段的API名称。
- id长整型
指定字段的ID。
- 值 字符串
指定在条件中使用的值。
- locked_for 字符串,可选
指定记录是否对所有配置文件进行锁定,或对所有配置文件进行锁定,但有少数例外。
可能的值: all_profiles_except_excluded_profile, all_profiles。
默认值: all_profiles。 - lock_excluded_profilesJSON 数组,当 locked_for 值为 "all_profiles_except_excluded_profiles" 时必填
表示被限制锁定的配置文件。
- api_name字符串
表示被限制锁定的配置文件的 API 名称。
- id长整型
表示被限制锁定的配置文件的 ID。
- excluded_fields JSON 数组,可选
指定从记录锁定中排除的字段。
- api_name字符串
指定从记录锁定中排除的字段的API名称。
- id长整型
指定从记录锁定中排除的字段的id。
- feature_type字符串,可选
指定记录锁定配置的特性类型。
可能的值: record_locking - restricted_actionsJSON 数组,可选
指定对锁定记录的限制操作。
可能的值:更新,标签,转换,删除,更改所有者
默认值:更新 - lock_for_portal_users布尔值,可选
指示是否将锁定的记录限制给门户用户。
默认值: true - restricted_communicationsJSON 数组,可选
指定对锁定记录进行限制的通信类型。
可能的值: send_mail - restricted_custom_buttonsJSON 数组,可选
代表被限制用于锁定记录的自定义按钮。
- name字符串
代表被限制用于锁定记录的自定义按钮的API名称。
- id长整型
代表被限制用于锁定记录的自定义按钮的ID。
注意
- 当在标准中给出的API名称或ID只有一个有效时,将使用有效值处理记录。
- 编辑操作在记录锁定配置中始终受到限制。即Restricted_actions总是包含值update。
样本输入
可能的错误
- REQUIRED_PARAM_MISSINGHTTP 400
缺少预期的参数之一。
解决方案: 响应中的 "details" 键提供了请求中缺少的参数。确保在 "Parameters" 部分中包含标记为 "mandatory" 的参数。 - INVALID_MODULEHTTP 400
给出的模块名称似乎无效。
解决方案: 指定一个有效的模块API名称。 - NOT_SUPPORTEDHTTP 400
- 给定的模块不受支持。
- 在条件中给出的API名称不受支持。
- 在条件中给出的值不受支持。
- 对于任务模块api_name任务状态和值关闭是唯一接受的值。任何其他条件都会抛出此错误。
- 条件中的字段不受支持。
- 条件中的值不受支持。
解决方案: 指定相应的支持值。
- FEATURE_NOT_SUPPORTEDHTTP 400
用户当前版本不支持记录锁定配置。
- INVALID_DATAHTTP 400
- 在记录锁定规则条件中指定的API名称无效。
- feature_type不是record_locking。
- 在请求体中为restricted_communications给出的值无效。有效值是send_mail, send_survery, send_portal_invitation。
- 在请求体中为restricted_actions给出的值无效。有效值是convert, update, delete, change_owner, tags。
- 给出的restricted_button值无效。
- 在请求体中为lock_type给出的值无效。有效值是manual, automatic或both。
- 在请求体中为locked_for给出的值无效。有效值是all_profiles或all_profiles_except_excluded_profiles。
- 给出的lock_excluded_profiles值无效。
- 给出的excluded_fields值无效。
解决方案:在请求中指定相应的有效值
- LIMIT_EXCEEDEDHTTP 400
- 超过了锁定规则的最大限制。
- 超过了自定义按钮的最大限制。
- 超过了排除字段的最大限制。
- 超过了排除配置文件的最大限制。
- 当您试图添加锁定规则配置,但它已经被配置过了。
解决方案: 参考响应中的"details"键,了解available_limit并修改请求体。
- MANDATORY_NOT_FOUNDHTTP 400
必填字段 lock_type 不存在。
解决方案: 在请求体中提供必填字段。
- EXPECTED_FIELD_MISSINGHTTP 400
在记录锁定规则的条件中缺少字段的id或api_name。
解决方案: 提供包含必要字段的条件。 - AMBIGUITY_DURING_PROCESSINGHTTP 400
标准中的字段的id和api_name属于不同的字段。
解决方案: 提供正确的api_name和id的标准。 - DEPENDENT_FIELD_MISSINGHTTP 400
- 当 "lock_type" 为 "both" 或 "automatic" 时,请求体中没有给出 'locking_rules' 键。
- 当 locked_for 值为 "all_profiles_except_excluded_profiles" 时,请求体中没有给出 "lock_excluded_profiles" 键。
解决方案: 在请求体中给出依赖字段。
- DUPLICATE_DATAHTTP 400
- 在条件中找到重复值。
- 在规则名称中找到重复值。
解决方案: 为相应的字段提供唯一值。
- INVALID_REQUEST_METHODHTTP 403
HTTP请求方法类型无效。
解决方案: 您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上面的端点部分。 - NO_PERMISSIONHTTP 403
拒绝权限自定义记录锁配置。用户没有权限。
解决方案: 联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误。
解决方案: 服务器中出现意外且未处理的异常。请联系支持团队。