查询合同的填写控件信息
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容，包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
如下图模板所示，发起后对方填写后，可以获取红框中用户填写的信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFlowComponents。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| FlowId | 是 | String | 合同流程ID，为32位字符串。 点击查看FlowId在控制台中的位置 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RecipientComponentInfos | Array of RecipientComponentInfo | 合同流程关联的填写控件信息，包括填写控件的归属方以及是否填写等内容。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询流程填写控件
1.查询流程填写控件 2.流程参与方yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj所有的控件都填写完成 3.流程参与方yDxZzUyKQDKuigUuO4zjEC4rpqaa8QgB、yDxZzUyKQDKuihUuO4zjEy09jfapyHjn没有填写控件
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowComponents
<公共请求参数>
{
"Operator": {
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
},
"FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm"
}
输出示例
{
"Response": {
"RecipientComponentInfos": [
{
"Components": [
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_13",
"ComponentName": "多行文本",
"ComponentValue": "转让期限：自2023年9月21日起至2025年9月30日",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_12",
"ComponentName": "单行文本",
"ComponentValue": "伍仟元整",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_14",
"ComponentName": "勾选框",
"ComponentValue": "true",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_16",
"ComponentName": "数字",
"ComponentValue": "5000",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_15",
"ComponentName": "选择器",
"ComponentValue": "选项1",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_17",
"ComponentName": "图片",
"ComponentValue": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH",
"ImageUrl": "https://file.test.ess.tencent.cn/bresource/resource/resource/yDRSRUUgygj6qnwfUuO4zjEwc193c2hH/0.PNG?hkey=a45a3e727c637df7826f9",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj"
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_19",
"ComponentName": "日期",
"ComponentValue": "2023年06月15日",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_20",
"ComponentName": "地址",
"ComponentValue": "广东省深圳市南山区海天二路33号",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_21",
"ComponentName": "邮箱",
"ComponentValue": "himer@xisi.com",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_22",
"ComponentName": "学历",
"ComponentValue": "小学",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_23",
"ComponentName": "性别",
"ComponentValue": "男",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_24",
"ComponentName": "省市区",
"ComponentValue": "广东省",
"ComponentRecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj",
"ImageUrl": ""
}
],
"IsPromoter": true,
"RecipientFillStatus": "1",
"RecipientId": "yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj"
},
{
"Components": [],
"IsPromoter": false,
"RecipientFillStatus": "",
"RecipientId": "yDxZzUyKQDKuigUuO4zjEC4rpqaa8QgB"
},
{
"Components": [],
"IsPromoter": false,
"RecipientFillStatus": "",
"RecipientId": "yDxZzUyKQDKuihUuO4zjEy09jfapyHjn"
}
],
"RequestId": "d245a68d-e13b-xxxx-xxxx-e5adc794db24"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.FlowHasNoDocument | 流程未找到关联的电子文件信息，请检查操作步骤，检查参数，并在修改后重试。 |
| InternalError | 内部错误。 |
| InvalidParameter.EmptyParams | 参数为空，请检查参数修改后重试。 |
| OperationDenied.Forbid | 禁止此项操作。 |
| OperationDenied.NoFlowPermission | 无权限操作签署流程，请联系客服了解权限，并在修改后重试。 |