跳到主要内容

导出合同审查结果

1. 接口描述​

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

本接口（ExportContractReviewResult）用于导出和同审查结果。支持选择 1 “带风险批注文件”、 2 “审查结果＆摘要（.xIsx）”

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ExportContractReviewResult。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
TaskId是String合同审查任务ID
示例值：yDtzKUUckffzxURVliRllhLFtn
FileType是Integer导出文件类型。1 = 带风险批注文件; 2 = 审查结果＆摘要（.xIsx）
示例值：1
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数​

参数名称类型描述
UrlString文件下载链接
示例值：https://file.ess.tencent.cn/bresource/resource/resource/0/0.DOCX?hkey=5336d1f1606055b00949c2a27818dc99723b96edadd6266ca2a4a65decf5b5203f6234f47e8c765759681bd08309e78d046c49a2a52fa864
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 导出审查结果和摘要 xlsx 文件​

输入示例​

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

{
    "Operator": {
        "UserId": "yDtzDUUckpfhotltUxpgD3IvZBJB10dg"
    },
    "TaskId": "yDtzZUUckpf8wewlUx7RX5uSd4QXIcRI",
    "FileType": 2
}

输出示例​

{
    "Response": {
        "RequestId": "57036460-8ab0-4a0f-b6ca-ec6e4f6cff57",
        "Url": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=533ef16b1c16d1f16060554ea3982785c3a30eda68f5c00f6947c7695feb18f97f24e189b77d14350036e89bca11f153f0ddf7c847233dd099d4ee826202371435d8080ec05323e868f41f14676d745a836d2064286b79c812144daaf68f1d661f87f3c43b04b61599a0630dafdef064b741be6c1dba5ab2528bdadfddfcca19e4c8dd5d57c6f61de3a7b186dde961d990bfa7e9fef5bd9a6169b8e1f381789a"
    }
}

示例2 导出带批注的审查文件​

输入示例​

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

{
    "Operator": {
        "UserId": "yDtzDUUkpfhotltUxD3IvZBJB10dg"
    },
    "TaskId": "yDtzZUckpf8wwlUx7RX5ud4QXIcRI",
    "FileType": 1
}

输出示例​

{
    "Response": {
        "RequestId": "27419bd6-09bf-459d-b514-295964b7478a",
        "Url": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.DOCX?hkey=533ef16b1c16d1f16060554ea3982785c3a30eda68f5c00f6947c7695feb18f9632ebfb577efc74e9b00949c2a27818dc99723b96edadd6266ca2a46f49ee8a6915a01f702b1932ca4b6687198aca50f02e6f9d61c8c32fac3df3741e6e9c032"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.DependsApi依赖的第三方API返回错误。
InternalError.DependsDb数据库执行错误。
InternalError.System系统错误，请稍后重试。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
更多开发者交流反馈