签署流程明细详情
<p><strong>简要描述:</strong> </p>
<ul>
<li>签署流程明细详情接口</li>
</ul>
<p><strong>请求URL:</strong> </p>
<ul>
<li><code>http://ip:port/service/rest/v1/signflow/detail</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;">flowId</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>签署流程Id, 若flowId为空,participantId必填, 目前只有发起人支持flowId查询</td>
</tr>
<tr>
<td style="text-align: left;">participantId</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>签署流程参与人Id,若participantId为空,flowId必填</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/detail?participantId=xx&amp;source=esign
</code></pre>
<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;participantId&quot;: &quot;00000900-35d6-4409-bc2a-ccf38d4d5b8c&quot;,
&quot;flowId&quot;: &quot;0b346c50-d606-4b65-9979-68fed87b36cb&quot;,
&quot;ownerId&quot;: &quot;E3C03E3AC0804187BCAF72F903B5B84C&quot;,
&quot;owner&quot;: &quot;杭州庆祥金狮首饰铺&quot;,
&quot;flowType&quot;: 2,
&quot;flowDocDataList&quot;: [
{
&quot;flowDocId&quot;: &quot;4712bf30-e1a9-4d71-8c83-9379c1f53851&quot;,
&quot;userFileId&quot;: &quot;64efb958-169e-4944-a48a-1096dfae3b52&quot;,
&quot;flowDocName&quot;: &quot;联络员信息.docx&quot;,
&quot;posList&quot;: [
{
&quot;posX&quot;: 20,
&quot;posY&quot;: 30,
&quot;posPage&quot;: 0,
&quot;key&quot;: &quot;电子邮箱&quot;,
&quot;signType&quot;: null
}
],
&quot;ossKey&quot;: &quot;doc-convert/84ae841509480bf813698eb9d14b7c21.pdf&quot;,
&quot;url&quot;: &quot;https://doc-convert.oss-cn-hangzhou.aliyuncs.com/84ae841509480bf813698eb9d14b7c21.pdf?Expires=1524741673&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=PyFn3YQbesL5L2Bw%2Bibxzpnn1Gc%3D&quot;,
&quot;reviewUrl&quot;: &quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/7XSK9GOxVxW_AblF_OE5ZL2Wm8nTnRiRFbVKoNcHDRw%3D_1_1_50?Expires=1524709573&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=CQV3sWcMB8WL8NIfHOg7IQCspDo%3D&quot;,
&quot;filetype&quot;: &quot;pdf&quot;,
&quot;page&quot;: 1,
&quot;createDate&quot;: 1508848239000
}
],
&quot;status&quot;: 2,
&quot;signDeadline&quot;: 1608307199000,
&quot;contractStartline&quot;: null,
&quot;contractDeadline&quot;: null,
&quot;initiateTime&quot;: 1508848239000,
&quot;completeTime&quot;: 1521552114000,
&quot;transferTimes&quot;: 0,
&quot;reason&quot;: null,
&quot;rejecter&quot;: null,
&quot;docName&quot;: &quot;adasda&quot;,
&quot;isReadOnly&quot;: 0,
&quot;isApplication&quot;: 0,
&quot;createTime&quot;: 1508848239000,
&quot;isOwner&quot;: 0,
&quot;payMethod&quot;: 0,
&quot;description&quot;: null,
&quot;isRealSign&quot;: 1,
&quot;evidenceId&quot;: null,
&quot;payAccountInfo&quot;: &quot;E3C03E3AC0804187BCAF72F903B5B84C&quot;,
&quot;payAccountName&quot;: &quot;杭州庆祥金狮首饰铺&quot;,
&quot;lastRemindDate&quot;: null,
&quot;isOldVersionData&quot;: 0,
&quot;flowSealDataList&quot;: [],
&quot;operationLogList&quot;: null,
&quot;receiverList&quot;: [
{
&quot;id&quot;: &quot;f095b7f3-5e44-4d46-a1f8-7d0388f4381f&quot;,
&quot;receiverType&quot;: 1,
&quot;receiverId&quot;: &quot;E3C03E3AC0804187BCAF72F903B5B84C&quot;,
&quot;accountType&quot;: 2,
&quot;account&quot;: &quot;18622028645&quot;,
&quot;logo&quot;: &quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/defaulthead.png?Expires=1524711073&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=j70g1Bk6OIZ4HjKcON86iZmK%2BrY%3D&quot;,
&quot;nickname&quot;: &quot;杭州庆祥金狮首饰铺&quot;,
&quot;isSafe&quot;: false,
&quot;ddUserId&quot;: null,
&quot;participantType&quot;: 1,
&quot;signStatus&quot;: 1,
&quot;isSigned&quot;: 1,
&quot;signDate&quot;: null,
&quot;viewDate&quot;: null,
&quot;signOrder&quot;: 0,
&quot;isApplication&quot;: 0,
&quot;operationLogDataList&quot;: null,
&quot;safe&quot;: false
},
{
&quot;id&quot;: &quot;00000900-35d6-4409-bc2a-ccf38d4d5b8c&quot;,
&quot;receiverType&quot;: 1,
&quot;receiverId&quot;: &quot;942B054820E94283967F38B98C3899FA&quot;,
&quot;accountType&quot;: 1,
&quot;account&quot;: &quot;15869154156&quot;,
&quot;logo&quot;: &quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/fd825542-5a2c-4198-b75b-9a02eaab983c?Expires=1524711073&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=xSrlFWR1QzIa2j4oYuL8KBEDTsQ%3D&quot;,
&quot;nickname&quot;: &quot;李苏婵&quot;,
&quot;isSafe&quot;: false,
&quot;ddUserId&quot;: null,
&quot;participantType&quot;: 0,
&quot;signStatus&quot;: 0,
&quot;isSigned&quot;: 0,
&quot;signDate&quot;: null,
&quot;viewDate&quot;: null,
&quot;signOrder&quot;: 1,
&quot;isApplication&quot;: 0,
&quot;operationLogDataList&quot;: null,
&quot;safe&quot;: false
},
{
&quot;id&quot;: &quot;4179048d-076f-4288-a6a2-811b23469403&quot;,
&quot;receiverType&quot;: 1,
&quot;receiverId&quot;: &quot;ABA63D92274D4B6AA1D3B979D67AC6E8&quot;,
&quot;accountType&quot;: 1,
&quot;account&quot;: &quot;第三方第三方的手&quot;,
&quot;logo&quot;: &quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/defaulthead.png?Expires=1524711073&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=j70g1Bk6OIZ4HjKcON86iZmK%2BrY%3D&quot;,
&quot;nickname&quot;: &quot;撒打算的&quot;,
&quot;isSafe&quot;: false,
&quot;ddUserId&quot;: null,
&quot;participantType&quot;: 0,
&quot;signStatus&quot;: 0,
&quot;isSigned&quot;: 0,
&quot;signDate&quot;: null,
&quot;viewDate&quot;: null,
&quot;signOrder&quot;: 1,
&quot;isApplication&quot;: 0,
&quot;operationLogDataList&quot;: null,
&quot;safe&quot;: false
}
]
}
}</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;">participantId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">签署流程参与人Id</td>
</tr>
<tr>
<td style="text-align: left;">flowId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">签署流程ID</td>
</tr>
<tr>
<td style="text-align: left;">ownerId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">发起人accountUid</td>
</tr>
<tr>
<td style="text-align: left;">owner</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">发起人姓名</td>
</tr>
<tr>
<td style="text-align: left;">isOwner</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">当前用户是否发起人, 0-否 1-是</td>
</tr>
<tr>
<td style="text-align: left;">flowType</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">签署流程类型,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 style="text-align: left;">签署流程状态,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 style="text-align: left;">签署流程名称</td>
</tr>
<tr>
<td style="text-align: left;">createTime</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">创建时间</td>
</tr>
<tr>
<td style="text-align: left;">initiateTime</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">发起时间[流程正式发起签署的时间]</td>
</tr>
<tr>
<td style="text-align: left;">completeTime</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">签署完成时间[签署完成时间为流程正常签署完成的最终时间]</td>
</tr>
<tr>
<td style="text-align: left;">signDeadline</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">截止时间[详情中返回值deadline改名为signDeadline]</td>
</tr>
<tr>
<td style="text-align: left;">contractStartline</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">合同有效起始时间</td>
</tr>
<tr>
<td style="text-align: left;">contractDealine</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">合同有效截止时间[新增合同有效期返回值,在详情页面需要展示]</td>
</tr>
<tr>
<td style="text-align: left;">transferTimes</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">转签次数</td>
</tr>
<tr>
<td style="text-align: left;">isRead</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">是否已读,0-未读 1- 已读</td>
</tr>
<tr>
<td style="text-align: left;">isApplication</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">是否用印申请或转签记录, 0-否 1-是</td>
</tr>
<tr>
<td style="text-align: left;">modifyDate</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">修改时间</td>
</tr>
<tr>
<td style="text-align: left;">isInitiated</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">流程是否已发起,0-未发起 1-已发起</td>
</tr>
<tr>
<td style="text-align: left;">reason</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">拒签原因或撤回原因</td>
</tr>
<tr>
<td style="text-align: left;">rejecter</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">拒签人accountUid</td>
</tr>
<tr>
<td style="text-align: left;">payMethod</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">付款方式 0-全部自己付 1-各自付 2-对方付</td>
</tr>
<tr>
<td style="text-align: left;">isReadOnly</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">是否只读</td>
</tr>
<tr>
<td style="text-align: left;">lastRemindDate</td>
<td style="text-align: left;">Date</td>
<td style="text-align: left;">最近一次催签时间</td>
</tr>
<tr>
<td style="text-align: left;">receiverList</td>
<td style="text-align: left;">List<ReceiverData></td>
<td style="text-align: left;">签署参与人列表,目前只有H5页面会返回列表值</td>
</tr>
<tr>
<td style="text-align: left;">flowDocDataList</td>
<td style="text-align: left;">List</td>
<td style="text-align: left;">签署流程文档信息</td>
</tr>
<tr>
<td style="text-align: left;">operationLogList</td>
<td style="text-align: left;">List</td>
<td style="text-align: left;">签署流程操作日志,目前只有钉签会返回该值</td>
</tr>
<tr>
<td style="text-align: left;">evidenceId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">存证Id, 只有正常完结且已存在的流程才会存在存证记录ID</td>
</tr>
</tbody>
</table>
<p>ReceiverData</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;">id</td>
<td style="text-align: left;">String</td>
<td>签署流程参与人Id</td>
</tr>
<tr>
<td style="text-align: left;">receiverType</td>
<td style="text-align: left;">int</td>
<td>参与人账号类型,1-accountUid, 2-手机号或邮箱</td>
</tr>
<tr>
<td style="text-align: left;">receiverId</td>
<td style="text-align: left;">String</td>
<td>签署流程名称/文档名称</td>
</tr>
<tr>
<td style="text-align: left;">participantType</td>
<td style="text-align: left;">int</td>
<td>参与类型,0-需签署 1-仅抄送</td>
</tr>
<tr>
<td style="text-align: left;">account</td>
<td style="text-align: left;">String</td>
<td>参与人账号,手机号或邮箱</td>
</tr>
<tr>
<td style="text-align: left;">nickname</td>
<td style="text-align: left;">String</td>
<td>参与人姓名</td>
</tr>
<tr>
<td style="text-align: left;">isSafe</td>
<td style="text-align: left;">Boolean</td>
<td>参与人账号是否安全</td>
</tr>
<tr>
<td style="text-align: left;">isSigned</td>
<td style="text-align: left;">int</td>
<td>参与人是否已签,0-未签,1-已签,2-拒签</td>
</tr>
<tr>
<td style="text-align: left;">signOrder</td>
<td style="text-align: left;">int</td>
<td>参与人签署顺序</td>
</tr>
<tr>
<td style="text-align: left;">isApplication</td>
<td style="text-align: left;">int</td>
<td>是否转签或用印申请产生的数据</td>
</tr>
<tr>
<td style="text-align: left;">transferReceiver</td>
<td style="text-align: left;">Receiver</td>
<td>转签人信息</td>
</tr>
</tbody>
</table>
<p>flowDocDataList</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;">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>