跳到主要内容

查询流程填写控件内容

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelDescribeFlowComponents。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
FlowIdString电子签流程的Id

3. 输出参数

参数名称类型描述
RecipientComponentInfosArray of RecipientComponentInfo流程关联的填写控件信息,控件会按照参与方进行分类。
注意:此字段可能返回 null,表示取不到有效值。
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 样例

样例

输入示例

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

{
"Agent": {
"AppId": "yDxxxxxxxxxxxxxxxxxxxxT8l",
"ProxyOrganizationOpenId": "xxxxxxxx",
"ProxyOperator": {
"OpenId": "xxxxxxxx"
}
},
"FlowId": "yDwxxxxxxxxxxxxxxxxxxxx1EZ"
}

输出示例

{
"Response": {
"RecipientComponentInfos": [
{
"Components": [
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_xxxxxx",
"ComponentName": "图片",
"ComponentValue": "yDxxxxxxxxxxxxxxxxxxxxxxxxxxx1Txm",
"ImageUrl": "https://xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx4cf5"
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_xx",
"ComponentName": "选择器",
"ComponentValue": "选择器123",
"ImageUrl": ""
},
{
"ComponentFillStatus": "1",
"ComponentId": "ComponentId_xx",
"ComponentName": "simpletext",
"ComponentValue": "simpletext123",
"ImageUrl": ""
}
],
"IsPromoter": true,
"RecipientFillStatus": "1",
"RecipientId": "yDxxxxxxxxxxxxxxxxxxxzf2X"
},
{
"Components": [
{
"ComponentFillStatus": "0",
"ComponentId": "ComponentId_xx",
"ComponentName": "企业全称",
"ComponentValue": "",
"ImageUrl": ""
}
],
"IsPromoter": false,
"RecipientFillStatus": "0",
"RecipientId": "yDxxxxxxxxxxxxxxxxxxxxxxxR3I2"
},
{
"Components": [
{
"ComponentFillStatus": "0",
"ComponentId": "ComponentId_xx",
"ComponentName": "单行文本",
"ComponentValue": "",
"ImageUrl": ""
}
],
"IsPromoter": false,
"RecipientFillStatus": "0",
"RecipientId": "yDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxY0"
}
],
"RequestId": "a34xxxxxxxxxxxxxxxxxxxxxxxxxxx6cf"
}
}

5. 错误码

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

错误码描述
InternalError内部错误。
InvalidParameter.EmptyParams参数为空。
OperationDenied操作被拒绝。
OperationDenied.NoFlowPermission无权操作合同。
ResourceNotFound.Flow未找到对应流程。