跳到主要内容

获取企业全部审查要点清单

1. 接口描述​

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

本接口（DescribeEnterpriseContractReviewChecklists）用于获取企业全部审查要点清单。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeEnterpriseContractReviewChecklists。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
Filters否Filter过滤条件
Limit否Integer指定每页返回的数据条数，和Offset参数配合使用。
示例值：10
Offset否Integer查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
示例值：0

3. 输出参数​

参数名称类型描述
TotalInteger查询的总条数
示例值：100
ChecklistsArray of Checklist清单列表
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 获取企业全部审查要点清单​

输入示例​

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

{
    "Operator": {
        "UserId": "yDtUckphotltxpgD3IZBJ10dg"
    }
}

输出示例​

{
    "Response": {
        "Checklists": [
            {
                "ConfigStatus": 1,
                "Count": 3,
                "Enabled": false,
                "Id": "yDtlUUckpfqe0eUx7RX5uRpuL96kx",
                "ModifiedOn": 1763628965,
                "Name": "审核",
                "Official": false,
                "Updater": "张三"
            },
            {
                "ConfigStatus": 1,
                "Count": 4,
                "Enabled": false,
                "Id": "yDtzUUkpfharbmUuErirRNRjLfwMQ",
                "ModifiedOn": 1763100881,
                "Name": "采购",
                "Official": false,
                "Updater": "李四"
            },
            {
                "ConfigStatus": 1,
                "Count": 4,
                "Enabled": true,
                "Id": "yDVUUckpfhvlrUuXEriCmkgEM2A6",
                "ModifiedOn": 1763091112,
                "Name": "购买",
                "Official": false,
                "Updater": "王五"
            }
        ],
        "RequestId": "f31368af-1ac2-47d6-80b6-146e12eb96eb",
        "Total": 3
    }
}

5. 错误码​

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

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