跳到主要内容

查询合同对比任务结果

1. 接口描述​

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

本接口（DescribeContractComparisonTask）用于查询合同对比任务结果详情。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeContractComparisonTask。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行合同审查任务的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
TaskId是String合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。
示例值：yD***ob

3. 输出参数​

参数名称类型描述
TaskIdString合同对比任务ID。
示例值：yD***ob
StatusInteger合同对比任务状态。
状态如下：
  • 0：待创建（未执行）
  • 1：对比中
  • 2：对比成功
  • 3：对比失败


示例值：2
MessageString对比失败的具体原因描述，仅当状态为失败时返回此字段。
示例值：对比失败
OriginalFileResourceIdString原版文件ID，对比基准的旧版本文件唯一标识。
示例值：yD***Cj
DiffFileResourceIdString新版文件ID，与旧版进行对比的新版本文件唯一标识。
示例值：yD***Ed
CommentString对比任务备注，长度不能超过50个字符。
示例值：这是一项对比任务
TotalDiffCountInteger合同对比差异点总数。
示例值：10
AddDiffCountInteger合同对比新增点数量。
示例值：4
ChangeDiffCountInteger合同对比修改点数量。
示例值：4
DeleteDiffCountInteger合同对比删除点数量。
示例值：2
OperatorString提交人，提交此任务或请求的用户唯一标识。
示例值：yD***dc
CreateTimeInteger合同对比任务创建时间，时间戳。
示例值：1758526698
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询合同对比任务结果​

本接口（DescribeContractComparisonTask）用于查询合同对比任务结果详情。

输入示例​

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

{
    "Operator": {
        "UserId": "yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7"
    },
    "TaskId": "yDtrrUUckp94goxhUyjVZ8rSEQ0lg7vb"
}

输出示例​

{
    "Response": {
        "AddDiffCount": 7,
        "ChangeDiffCount": 2,
        "Comment": "备注备注备注",
        "CreateTime": 1758526698,
        "DeleteDiffCount": 3,
        "DiffFileResourceId": "yDtryUUckp9tv5kcUEdITpJ9VXDn080c",
        "Message": "",
        "Operator": "yDtGuUUckp955n9yUECLj6JusBmg10dc",
        "OriginalFileResourceId": "yDtryUUckp9tv5odUEdITpJvu1v2faCj",
        "RequestId": "s1760000134519523795",
        "Status": 2,
        "TaskId": "yDtrrUUckp94goxhUyjVZ8rSEQ0lg7vb",
        "TotalDiffCount": 12
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError.Db数据库异常。
InvalidParameterValue参数取值错误。
OperationDenied操作被拒绝。
ResourceNotFound资源不存在。
更多开发者交流反馈