1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
此接口(ImportRiskIdentificationChecklist)用于创建或更新合同审查清单。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ImportContractReviewChecklist。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 |
| Name | 是 | String | 导入的合同审查清单名称 示例值:测试API创建审查清单 |
| Categories.N | 是 | Array of ChecklistCategory | 导入的合同审查清单审查点列表 |
| Agent | 否 | Agent | 代理企业和员工的信息。 |
| ChecklistID | 否 | String | 如果传值,则更新对应的合同审查清单,否则创建新的合同审查清单 示例值:yD3XCUUckpzdumlzUyb9Q4tyW8MppCjy |
| Enabled | 否 | Boolean | 设置为true则启动清单,否则禁用清单 示例值:true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ChecklistId | String | 导入成功的合同审查清单ID 示例值:yD3XCUUckpzdumlzUyb9Q4tyW8MppCjy |
| RequestId | String | 唯一请求 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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.Db | 数据库异常。 |
| InternalError.DependsApi | 依赖的第三方API返回错误。 |
| InternalError.DependsDb | 数据库执行错误。 |
| InternalError.System | 系统错误,请稍后重试。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.Forbid | 禁止此项操作。 |
| ResourceNotFound.Template | 模板不存在,请检查模板参数,模板配置,并稍后重试。 |