签署流程列表查询
<p><strong>简要描述:</strong> </p>
<ul>
<li>签署流程列表查询接口</li>
</ul>
<p><strong>请求URL:</strong> </p>
<ul>
<li><code>http://ip:port/service/rest/v1/signflow/list</code></li>
</ul>
<p><strong>请求方式:</strong></p>
<ul>
<li>GET</li>
</ul>
<p><strong>请求参数:</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">accountUid</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>用户账号UID, 标准签可不传,若不传默认为当前登录人UID</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>签署流程状态,0-草稿,1-待签,2-待我签,3-待他人签,4-申请中,6-拒签,7-撤回,8-已过期,9-已签署,10-已完结,11-已存证,14-云文件</td>
</tr>
<tr>
<td style="text-align: left;">docName</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>签署流程名称</td>
</tr>
<tr>
<td style="text-align: left;">senderKeyInfo</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>发起人关键字信息</td>
</tr>
<tr>
<td style="text-align: left;">receiverKeyInfo</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>签署人关键字信息</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>页码</td>
</tr>
<tr>
<td style="text-align: left;">pageSize</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>每页数据大小</td>
</tr>
<tr>
<td style="text-align: left;">showReceivers</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>是否显示参与人信息 0-否 1-是, 默认不显示</td>
</tr>
<tr>
<td style="text-align: left;">source</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>请求来源,例如:’dingding’ , ’esign’ , ’esign_h5’ , ’alipay’</td>
</tr>
</tbody>
</table>
<p><strong>请求示例</strong></p>
<pre><code> http://ip:port/service/rest/v1/signflow/list?status=0&amp;source=esign&amp;page=1&amp;pageSize=5</code></pre>
<p><strong>返回参数</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">participantId</td>
<td style="text-align: left;">String</td>
<td>签署流程参与人Id</td>
</tr>
<tr>
<td style="text-align: left;">flowDetailId</td>
<td style="text-align: left;">String</td>
<td>签署流程详情Id, 为兼容钉钉,目前无使用场景</td>
</tr>
<tr>
<td style="text-align: left;">flowId</td>
<td style="text-align: left;">String</td>
<td>签署流程ID</td>
</tr>
<tr>
<td style="text-align: left;">senderId</td>
<td style="text-align: left;">String</td>
<td>发起人accountUid</td>
</tr>
<tr>
<td style="text-align: left;">senderName</td>
<td style="text-align: left;">String</td>
<td>发起人姓名</td>
</tr>
<tr>
<td style="text-align: left;">isOwner</td>
<td style="text-align: left;">int</td>
<td>当前用户是否发起人, 0-否 1-是</td>
</tr>
<tr>
<td style="text-align: left;">flowType</td>
<td style="text-align: left;">int</td>
<td>签署流程类型,0-仅自己签 1-顺序签 2-无序签 3-单独签 4-云文件 5-无流程 6-批量签</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">int</td>
<td>签署流程状态,0-草稿,2-待我签,3,-待他人签,6-已拒签,7-已撤回,8-已过期,9-已完成,10-已处理</td>
</tr>
<tr>
<td style="text-align: left;">docName</td>
<td style="text-align: left;">String</td>
<td>签署流程名称</td>
</tr>
<tr>
<td style="text-align: left;">createTime</td>
<td style="text-align: left;">long</td>
<td>创建时间</td>
</tr>
<tr>
<td style="text-align: left;">signDeadline</td>
<td style="text-align: left;">long</td>
<td>截止时间</td>
</tr>
<tr>
<td style="text-align: left;">isRead</td>
<td style="text-align: left;">int</td>
<td>是否已读,0-未读 1- 已读</td>
</tr>
<tr>
<td style="text-align: left;">isApplication</td>
<td style="text-align: left;">int</td>
<td>是否用印申请或转签记录, 0-否 1-是</td>
</tr>
<tr>
<td style="text-align: left;">modifyDate</td>
<td style="text-align: left;">long</td>
<td>修改时间</td>
</tr>
<tr>
<td style="text-align: left;">isInitiated</td>
<td style="text-align: left;">int</td>
<td>流程是否已发起,0-未发起 1-已发起</td>
</tr>
<tr>
<td style="text-align: left;">reason</td>
<td style="text-align: left;">String</td>
<td>拒签原因或撤回原因</td>
</tr>
<tr>
<td style="text-align: left;">lastOperation</td>
<td style="text-align: left;">OperationLogData</td>
<td>最近一次操作记录</td>
</tr>
<tr>
<td style="text-align: left;">transferTimes</td>
<td style="text-align: left;">int</td>
<td>转签次数,默认为0 [添加于2018-03-06, 转签次数,用于限制参与人是否可以执行转签操作,目前设置的最大转签次数为5次,限制逻辑由前端判断]</td>
</tr>
<tr>
<td style="text-align: left;">positioned</td>
<td style="text-align: left;">boolean</td>
<td>是否指定签署位置</td>
</tr>
<tr>
<td style="text-align: left;">receiverList</td>
<td style="text-align: left;">List</td>
<td>签署参与人列表,目前只有H5页面会返回列表值</td>
</tr>
</tbody>
</table>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;success&quot;: true,
&quot;msg&quot;: &quot;成功&quot;,
&quot;total&quot;: null,
&quot;errCode&quot;: 0,
&quot;errShow&quot;: false,
&quot;data&quot;: {
&quot;total&quot;: 18, //记录统计
&quot;page&quot;: 2,
&quot;pageSize&quot;: 10,
&quot;signFlows&quot;: [
{
&quot;participantId&quot;: &quot;5395bc64-eca4-4671-bfc8-7f3191f471f2&quot;,
&quot;flowDetailId&quot;: null,
&quot;flowId&quot;: &quot;5340df21-6538-4c96-93bc-2aea16ac4866&quot;,
&quot;senderId&quot;: &quot;942B054820E94283967F38B98C3899FA&quot;,
&quot;senderName&quot;: &quot;李苏婵&quot;,
&quot;isOwner&quot;: 1,
&quot;flowType&quot;: 3,
&quot;status&quot;: 2,
&quot;docName&quot;: &quot;单独签测试&quot;,
&quot;createTime&quot;: 1504842878000,
&quot;deadline&quot;: null,
&quot;isRead&quot;: 1,
&quot;isApplication&quot;: 0,
&quot;modifyDate&quot;: 1504843734000,
&quot;isInitiated&quot;: 1,
&quot;reason&quot;: null,
&quot;lastOperation&quot;: null,
&quot;receiverList&quot;: null,
&quot;positioned&quot;:false
}
]
}
}</code></pre>
<p><strong>备注</strong> </p>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>