标准签


签署流程明细详情

<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;amp;source=esign </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;participantId&amp;quot;: &amp;quot;00000900-35d6-4409-bc2a-ccf38d4d5b8c&amp;quot;, &amp;quot;flowId&amp;quot;: &amp;quot;0b346c50-d606-4b65-9979-68fed87b36cb&amp;quot;, &amp;quot;ownerId&amp;quot;: &amp;quot;E3C03E3AC0804187BCAF72F903B5B84C&amp;quot;, &amp;quot;owner&amp;quot;: &amp;quot;杭州庆祥金狮首饰铺&amp;quot;, &amp;quot;flowType&amp;quot;: 2, &amp;quot;flowDocDataList&amp;quot;: [ { &amp;quot;flowDocId&amp;quot;: &amp;quot;4712bf30-e1a9-4d71-8c83-9379c1f53851&amp;quot;, &amp;quot;userFileId&amp;quot;: &amp;quot;64efb958-169e-4944-a48a-1096dfae3b52&amp;quot;, &amp;quot;flowDocName&amp;quot;: &amp;quot;联络员信息.docx&amp;quot;, &amp;quot;posList&amp;quot;: [ { &amp;quot;posX&amp;quot;: 20, &amp;quot;posY&amp;quot;: 30, &amp;quot;posPage&amp;quot;: 0, &amp;quot;key&amp;quot;: &amp;quot;电子邮箱&amp;quot;, &amp;quot;signType&amp;quot;: null } ], &amp;quot;ossKey&amp;quot;: &amp;quot;doc-convert/84ae841509480bf813698eb9d14b7c21.pdf&amp;quot;, &amp;quot;url&amp;quot;: &amp;quot;https://doc-convert.oss-cn-hangzhou.aliyuncs.com/84ae841509480bf813698eb9d14b7c21.pdf?Expires=1524741673&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=PyFn3YQbesL5L2Bw%2Bibxzpnn1Gc%3D&amp;quot;, &amp;quot;reviewUrl&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/7XSK9GOxVxW_AblF_OE5ZL2Wm8nTnRiRFbVKoNcHDRw%3D_1_1_50?Expires=1524709573&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=CQV3sWcMB8WL8NIfHOg7IQCspDo%3D&amp;quot;, &amp;quot;filetype&amp;quot;: &amp;quot;pdf&amp;quot;, &amp;quot;page&amp;quot;: 1, &amp;quot;createDate&amp;quot;: 1508848239000 } ], &amp;quot;status&amp;quot;: 2, &amp;quot;signDeadline&amp;quot;: 1608307199000, &amp;quot;contractStartline&amp;quot;: null, &amp;quot;contractDeadline&amp;quot;: null, &amp;quot;initiateTime&amp;quot;: 1508848239000, &amp;quot;completeTime&amp;quot;: 1521552114000, &amp;quot;transferTimes&amp;quot;: 0, &amp;quot;reason&amp;quot;: null, &amp;quot;rejecter&amp;quot;: null, &amp;quot;docName&amp;quot;: &amp;quot;adasda&amp;quot;, &amp;quot;isReadOnly&amp;quot;: 0, &amp;quot;isApplication&amp;quot;: 0, &amp;quot;createTime&amp;quot;: 1508848239000, &amp;quot;isOwner&amp;quot;: 0, &amp;quot;payMethod&amp;quot;: 0, &amp;quot;description&amp;quot;: null, &amp;quot;isRealSign&amp;quot;: 1, &amp;quot;evidenceId&amp;quot;: null, &amp;quot;payAccountInfo&amp;quot;: &amp;quot;E3C03E3AC0804187BCAF72F903B5B84C&amp;quot;, &amp;quot;payAccountName&amp;quot;: &amp;quot;杭州庆祥金狮首饰铺&amp;quot;, &amp;quot;lastRemindDate&amp;quot;: null, &amp;quot;isOldVersionData&amp;quot;: 0, &amp;quot;flowSealDataList&amp;quot;: [], &amp;quot;operationLogList&amp;quot;: null, &amp;quot;receiverList&amp;quot;: [ { &amp;quot;id&amp;quot;: &amp;quot;f095b7f3-5e44-4d46-a1f8-7d0388f4381f&amp;quot;, &amp;quot;receiverType&amp;quot;: 1, &amp;quot;receiverId&amp;quot;: &amp;quot;E3C03E3AC0804187BCAF72F903B5B84C&amp;quot;, &amp;quot;accountType&amp;quot;: 2, &amp;quot;account&amp;quot;: &amp;quot;18622028645&amp;quot;, &amp;quot;logo&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/defaulthead.png?Expires=1524711073&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=j70g1Bk6OIZ4HjKcON86iZmK%2BrY%3D&amp;quot;, &amp;quot;nickname&amp;quot;: &amp;quot;杭州庆祥金狮首饰铺&amp;quot;, &amp;quot;isSafe&amp;quot;: false, &amp;quot;ddUserId&amp;quot;: null, &amp;quot;participantType&amp;quot;: 1, &amp;quot;signStatus&amp;quot;: 1, &amp;quot;isSigned&amp;quot;: 1, &amp;quot;signDate&amp;quot;: null, &amp;quot;viewDate&amp;quot;: null, &amp;quot;signOrder&amp;quot;: 0, &amp;quot;isApplication&amp;quot;: 0, &amp;quot;operationLogDataList&amp;quot;: null, &amp;quot;safe&amp;quot;: false }, { &amp;quot;id&amp;quot;: &amp;quot;00000900-35d6-4409-bc2a-ccf38d4d5b8c&amp;quot;, &amp;quot;receiverType&amp;quot;: 1, &amp;quot;receiverId&amp;quot;: &amp;quot;942B054820E94283967F38B98C3899FA&amp;quot;, &amp;quot;accountType&amp;quot;: 1, &amp;quot;account&amp;quot;: &amp;quot;15869154156&amp;quot;, &amp;quot;logo&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/fd825542-5a2c-4198-b75b-9a02eaab983c?Expires=1524711073&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=xSrlFWR1QzIa2j4oYuL8KBEDTsQ%3D&amp;quot;, &amp;quot;nickname&amp;quot;: &amp;quot;李苏婵&amp;quot;, &amp;quot;isSafe&amp;quot;: false, &amp;quot;ddUserId&amp;quot;: null, &amp;quot;participantType&amp;quot;: 0, &amp;quot;signStatus&amp;quot;: 0, &amp;quot;isSigned&amp;quot;: 0, &amp;quot;signDate&amp;quot;: null, &amp;quot;viewDate&amp;quot;: null, &amp;quot;signOrder&amp;quot;: 1, &amp;quot;isApplication&amp;quot;: 0, &amp;quot;operationLogDataList&amp;quot;: null, &amp;quot;safe&amp;quot;: false }, { &amp;quot;id&amp;quot;: &amp;quot;4179048d-076f-4288-a6a2-811b23469403&amp;quot;, &amp;quot;receiverType&amp;quot;: 1, &amp;quot;receiverId&amp;quot;: &amp;quot;ABA63D92274D4B6AA1D3B979D67AC6E8&amp;quot;, &amp;quot;accountType&amp;quot;: 1, &amp;quot;account&amp;quot;: &amp;quot;第三方第三方的手&amp;quot;, &amp;quot;logo&amp;quot;: &amp;quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/defaulthead.png?Expires=1524711073&amp;amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;amp;Signature=j70g1Bk6OIZ4HjKcON86iZmK%2BrY%3D&amp;quot;, &amp;quot;nickname&amp;quot;: &amp;quot;撒打算的&amp;quot;, &amp;quot;isSafe&amp;quot;: false, &amp;quot;ddUserId&amp;quot;: null, &amp;quot;participantType&amp;quot;: 0, &amp;quot;signStatus&amp;quot;: 0, &amp;quot;isSigned&amp;quot;: 0, &amp;quot;signDate&amp;quot;: null, &amp;quot;viewDate&amp;quot;: null, &amp;quot;signOrder&amp;quot;: 1, &amp;quot;isApplication&amp;quot;: 0, &amp;quot;operationLogDataList&amp;quot;: null, &amp;quot;safe&amp;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&lt;ReceiverData&gt;</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>

页面列表

ITEM_HTML