跳到主要内容

导入合同风险审查清单

1. 接口描述

接口请求域名: ess.tencentcloudapi.com 。

此接口(ImportRiskIdentificationChecklist)用于创建或更新合同审查清单。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:ImportContractReviewChecklist。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo

执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

NameString

导入的合同审查清单名称


示例值:测试API创建审查清单
Categories.NArray of ChecklistCategory

导入的合同审查清单审查点列表

AgentAgent

代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

ChecklistIDString

如果传值,则更新对应的合同审查清单,否则创建新的合同审查清单


示例值:yD3XCUUckpzdumlzUyb9Q4tyW8MppCjy
EnabledBoolean

设置为true则启动清单,否则禁用清单


示例值:true

3. 输出参数

参数名称类型描述
ChecklistIdString

导入成功的合同审查清单ID


示例值:yD3XCUUckpzdumlzUyb9Q4tyW8MppCjy
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 常规导入合同风险审查清单

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportContractReviewChecklist
<公共请求参数>

{
"Operator": {
"UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw"
},
"Name": "测试API创建审查清单",
"Categories": [
{
"Name": "主体信息审查",
"Points": [
{
"Summary": "签约方主体信息完整明确",
"Explanation": "审查合同中签约方主体信息是否完善,企业签署方需包括企业名称、统一社会信用代码、法定代表人/经办人的姓名和有效身份证件号。个人签署方需要包括个人姓名和有效身份证件号。",
"RiskLevel": "高风险",
"IsIndispensable": false,
"IsConsistentWithReferenceItem": false,
"ReferenceItem": "可以参考的条款",
"Suggestion": "固定建议",
"AiSuggestion": "AI生成建议",
"RiskPresentation": [
"身份"
]
}
]
}
],
"ChecklistID": "yD3XCUUckpzdumlzUyb9Q4tyW8MppCjy",
"Enabled": true
}

输出示例

{
"Response": {
"ChecklistId": "yD3XCUUckpzdumlzUyb9Q4tyW8MppCjy",
"RequestId": "224836f8-22d1-4255-9077-c38f8e314153"
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.DependsApi依赖的第三方API返回错误。
InternalError.DependsDb数据库执行错误。
InternalError.System系统错误,请稍后重试。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.Forbid禁止此项操作。
ResourceNotFound.Template模板不存在,请检查模板参数,模板配置,并稍后重试。
更多开发者交流反馈