标准签


获取文档基本信息列表

<p><strong>简要描述:</strong> </p> <ul> <li>获取文档基本信息列表</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://ip:port/service/rest/v1/signflow/batch/docInfos</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </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;">participantList</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>签署流程参与人Id列表</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/batch/docInfos { &amp;quot;participantList&amp;quot;:[&amp;quot;282627ca-7fd3-4f8a-b0ba-xxxx&amp;quot;,&amp;quot;fefdab1b-82e2-4f29-b3a5-xxx&amp;quot;], &amp;quot;source&amp;quot;:&amp;quot;esign&amp;quot; } </code></pre> <p><strong>返回示例</strong></p> <pre><code>{ &amp;quot;success&amp;quot;: true, &amp;quot;msg&amp;quot;: &amp;quot;成功&amp;quot;, &amp;quot;total&amp;quot;: null, &amp;quot;errCode&amp;quot;: 0, &amp;quot;errShow&amp;quot;: false, &amp;quot;data&amp;quot;: { &amp;quot;allSamePage&amp;quot;: false, &amp;quot;flowCount&amp;quot;:1, &amp;quot;docCount&amp;quot;:3, &amp;quot;docList&amp;quot;: [ { &amp;quot;flowDocId&amp;quot;: &amp;quot;5b88cc05-067b-4a65-a274-fd9f1462d3c3&amp;quot;, &amp;quot;userFileId&amp;quot;: &amp;quot;753e8dc8-0dd1-49ca-a540-dbbfe04ad3c7&amp;quot;, &amp;quot;flowDocName&amp;quot;: &amp;quot;授权委托书 富县&amp;quot;, &amp;quot;flowName&amp;quot;: &amp;quot;测试搜索服务11&amp;quot;, &amp;quot;posList&amp;quot;: null, &amp;quot;ossKey&amp;quot;: &amp;quot;web/26955cd3-e854-43ec-b3a9-7211ba7e069e.pdf&amp;quot;, &amp;quot;url&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/web/26955cd3-e854-43ec-b3a9-7211ba7e069e.pdf?Expires=1532019763&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=IkcaDoI9iUhV8hD9bn6zODg98G0%3D&amp;quot;, &amp;quot;reviewUrl&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/mUXOa1fK16tvdHRL_TwsOCR9MfpRU8v-HpJbdRzYdl8%3D_1_1_50?Expires=1531987664&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=U9%2FGqHOS5NTJHX46zba%2BmkgOSgw%3D&amp;quot;, &amp;quot;filetype&amp;quot;: &amp;quot;pdf&amp;quot;, &amp;quot;page&amp;quot;: 1, &amp;quot;createDate&amp;quot;: 1528101235000 }, { &amp;quot;flowDocId&amp;quot;: &amp;quot;8ce1d40e-2b5e-4b1e-a53e-5113c2ec5271&amp;quot;, &amp;quot;userFileId&amp;quot;: &amp;quot;dbf5d155-5b51-41a0-a59a-502cee1f5c52&amp;quot;, &amp;quot;flowDocName&amp;quot;: &amp;quot;微信小程序DEMO需求-----与行方沟通后-----20180313&amp;quot;, &amp;quot;flowName&amp;quot;: &amp;quot;微信小程序DEMO需求-20180313&amp;quot;, &amp;quot;posList&amp;quot;: null, &amp;quot;ossKey&amp;quot;: &amp;quot;web/f94ee07b-ea51-48cf-a1c4-cb41dc9a954c.pdf&amp;quot;, &amp;quot;url&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/web/f94ee07b-ea51-48cf-a1c4-cb41dc9a954c.pdf?Expires=1532019763&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=ccmsi4Lq6uBLopTMlLt5EsJBGPk%3D&amp;quot;, &amp;quot;reviewUrl&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/KQeRSuWGvU08QjKzaskPRxGzc1JMkkl4nA99qJ2NSKw%3D_1_1_50?Expires=1531987665&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=tt0taVFjo%2ByfNO6HaVqsFfT8iwg%3D&amp;quot;, &amp;quot;filetype&amp;quot;: &amp;quot;pdf&amp;quot;, &amp;quot;page&amp;quot;: 1, &amp;quot;createDate&amp;quot;: 1525933953000 } ], &amp;quot;positionedStatus&amp;quot;: 0, &amp;quot;minPageDoc&amp;quot;: { &amp;quot;flowDocId&amp;quot;: &amp;quot;5b88cc05-067b-4a65-a274-fd9f1462d3c3&amp;quot;, &amp;quot;userFileId&amp;quot;: &amp;quot;753e8dc8-0dd1-49ca-a540-dbbfe04ad3c7&amp;quot;, &amp;quot;flowDocName&amp;quot;: &amp;quot;授权委托书 富县&amp;quot;, &amp;quot;flowName&amp;quot;: &amp;quot;测试搜索服务11&amp;quot;, &amp;quot;posList&amp;quot;: null, &amp;quot;ossKey&amp;quot;: &amp;quot;web/26955cd3-e854-43ec-b3a9-7211ba7e069e.pdf&amp;quot;, &amp;quot;url&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/web/26955cd3-e854-43ec-b3a9-7211ba7e069e.pdf?Expires=1532019763&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=IkcaDoI9iUhV8hD9bn6zODg98G0%3D&amp;quot;, &amp;quot;reviewUrl&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/mUXOa1fK16tvdHRL_TwsOCR9MfpRU8v-HpJbdRzYdl8%3D_1_1_50?Expires=1531987664&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=U9%2FGqHOS5NTJHX46zba%2BmkgOSgw%3D&amp;quot;, &amp;quot;filetype&amp;quot;: &amp;quot;pdf&amp;quot;, &amp;quot;page&amp;quot;: 1, &amp;quot;createDate&amp;quot;: 1528101235000 } } }</code></pre> <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> </tr> </thead> <tbody> <tr> <td style="text-align: left;">allSamePage</td> <td style="text-align: left;">boolean</td> <td style="text-align: left;">页数是否一致</td> </tr> <tr> <td style="text-align: left;">flowCount</td> <td style="text-align: left;">int</td> <td style="text-align: left;">流程统计</td> </tr> <tr> <td style="text-align: left;">docCount</td> <td style="text-align: left;">int</td> <td style="text-align: left;">合同统计</td> </tr> <tr> <td style="text-align: left;">docList</td> <td style="text-align: left;">List&lt;SignFlowDocData&gt;</td> <td style="text-align: left;">签署流程文档信息</td> </tr> <tr> <td style="text-align: left;">positionedStatus</td> <td style="text-align: left;">List</td> <td style="text-align: left;">指定位置情况, -1 都没有指定位置 0 部分指定位置 1 都指定了位置</td> </tr> <tr> <td style="text-align: left;">minPageDoc</td> <td style="text-align: left;">SignFlowDocData</td> <td style="text-align: left;">页数最小的文档</td> </tr> </tbody> </table> <p>SignFlowDocData</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;">flowDocId</td> <td style="text-align: left;">String</td> <td>签署流程文档ID</td> </tr> <tr> <td style="text-align: left;">userFileId</td> <td style="text-align: left;">String</td> <td>用户文件Id</td> </tr> <tr> <td style="text-align: left;">flowDocName</td> <td style="text-align: left;">String</td> <td>文件名称</td> </tr> <tr> <td style="text-align: left;">flowName</td> <td style="text-align: left;">String</td> <td>流程名称</td> </tr> <tr> <td style="text-align: left;">posList</td> <td style="text-align: left;">List</td> <td>指定位置信息</td> </tr> <tr> <td style="text-align: left;">ossKey</td> <td style="text-align: left;">String</td> <td>文件的ossKey</td> </tr> <tr> <td style="text-align: left;">url</td> <td style="text-align: left;">String</td> <td>文件的下载地址</td> </tr> <tr> <td style="text-align: left;">reviewUrl</td> <td style="text-align: left;">String</td> <td>文件首页预览地址</td> </tr> <tr> <td style="text-align: left;">page</td> <td style="text-align: left;">int</td> <td>文件页数</td> </tr> <tr> <td style="text-align: left;">createDate</td> <td style="text-align: left;">Date</td> <td>文档上传时间</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML