记录锁定信息APIs
记录锁定信息API允许您锁定记录,解锁记录,查看锁定记录的锁定信息并编辑锁定记录的锁定信息。
获取记录锁定信息
目的
检索被锁定记录的锁定信息详情。
端点
- GET /{module_API_name}/{record_id}/Locking_Information__s
- GET /{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id}
请求详情
Request URL
{api-domain}/crm/{version}/{module_API_name}/{record_id}/Locking_Information__s
获取特定记录锁定id:
{api-domain}/crm/{version}/{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id}
头部
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.lockinginformation.All (或) scope=ZohoCRM.modules.lockinginformation.Read
(和)
scope=ZohoCRM.modules.All (或) scope=ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
潜在客户,账户,联系人,交易,任务,案例,解决方案,供应商,价格表,报价,销售订单,采购订单,发票和自定义
可能的操作类型
全部 - 对记录的完全访问
读取 - 从模块中读取记录
样本请求
参数
- fields 字符串,当记录锁定id未在端点中指定时为必填。
指定响应中所需的字段名称。您可以指定由逗号分隔的多个字段API名称。
可能的值:
Locked_For__s, Locked_Reason__s, Lock_Source__s, Locked_Time__s, Locked_By__s, Record_Locking_Rule_Id__s, Record_Locking_Configuration_Id__s, Owner, Parent_Id
Note
- 对于自定义模块,只有用户创建的模块才支持记录锁定。通过扩展、集成或其他方式创建的自定义模块不受支持。
Response JSON 键
- Locked_By__sJSON 对象
表示锁定记录的用户的详细信息。对于自动记录锁定,此 JSON 对象将填充为 null。
- name字符串
表示锁定记录的用户的名称。
- id长整型
表示锁定记录的用户的 ID。
- Locked_For__sJSON 对象
代表被锁定记录的详细信息。
- moduleJSON 对象
代表被锁定记录的模块的详细信息。
- api_name字符串
代表被锁定记录的模块的API名称。
- id长整型
代表被锁定记录的模块的ID。
- name字符串
代表被锁定记录的名称。
- id长整型
代表被锁定记录的ID。
- Locked_Reason__sstring
表示记录被锁定的原因。对于自动记录锁定,此JSON对象将被填充为null。
- Lock_Source__s字符串
指示记录是手动锁定还是自动锁定。
可能的值:手动,自动。 - Locked_Time__sstring
代表记录被锁定的时间。
- Record_Locking_Configuration_Id__slong
代表记录锁定配置的ID。
- Record_Locking_Rule_Id__slong
代表记录锁定配置规则的ID。对于手动记录锁定,此JSON对象将填充为null。
- idlong
Represents the ID of locking information.
可能的错误
- REQUIRED_PARAM_MISSINGHTTP 400
缺少预期的参数之一。
解决方案: 响应中的 "details" 键提供了请求中缺少的参数。确保在 "Parameters" 部分中包含标记为 "mandatory" 的参数。 - NOT_ALLOWEDHTTP 400
缺少必需的记录锁定配置。
解决方案:在您的组织中创建记录锁定配置。 - INVALID_DATAHTTP 400
给出的关系id似乎无效。
解决方案: 提供有效的模块id。 - INVALID_DATAHTTP 400
给出的相关id似乎无效。
解决方案:提供有效的锁定信息id。 - FEATURE_NOT_SUPPORTEDHTTP 400
您的版本不支持记录锁定配置。
解决方案: 联系您的管理员。 - NO_PERMISSIONHTTP 403
用户的配置文件不支持记录锁定配置。
解决方案: 联系您的管理员。 - INVALID_REQUEST_METHODHTTP 403
HTTP 请求方法类型无效。
解决方案: 您指定了无效的 HTTP 方法来访问 API URL。请指定一个有效的请求方法。请参考上面的端点部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案: 服务器中出现意外且未处理的异常。请联系支持团队。