签署流程明细详情1101版
<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>{
"success": true,
"msg": "成功",
"total": null,
"errCode": 0,
"errShow": false,
"data": {
"participantId": "4bbb51c2-fb8d-457b-a76e-18dcc1f56dbb",
"flowId": "d9d0c970-b10f-4086-b215-3447c3f2ba05",
"ownerId": "942B054820E94283967F38B98C3899FA",
"owner": "李苏婵",
"flowType": 2,
"flowDocDataList": [
{
"flowDocId": "056264b9-7e91-4cdb-bed7-f00cd14c613e",
"userFileId": "af19f302-4e5e-4053-abe6-219e91bc419d",
"flowDocName": "申请出证接口",
"flowName": "测试指定位置签章日期4",
"posList": [
{
"posX": 65,
"posY": 309,
"posPage": "1",
"key": null,
"signType": 1,
"positionId": "70bb9e75-9d0a-4a00-b77b-96bac41b3397"
},
{
"posX": 255,
"posY": 309,
"posPage": "2",
"key": null,
"signType": 1,
"positionId": "d89f7432-dd2a-46db-a31f-9b5c5844f907"
}
],
"signDatePosList": [
{
"posPage": 1,
"posX": 65.462,
"posY": 503.538,
"fontSize": 1,
"description": null
}
],
"ossKey": "doc-convert/20181022/ff4a4c204614003aa5378eba2589e3fc.pdf",
"url": "https://doc-convert.oss-cn-hangzhou.aliyuncs.com/20181022/ff4a4c204614003aa5378eba2589e3fc.pdf?Expires=1540226118&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=z36YX7WsQ5QpvOzijFrhseuFR/s%3D",
"reviewUrl": "https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/Nlj8muFO_PwK-qj7fh5tLY5YMax14Or_bHZhibqOLFg%3D_2_1_50?Expires=1540194110&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=9Y%2BD6EZN29hoU91aAkRkefTjU5k%3D",
"filetype": "docx",
"page": 2,
"fileSize": 14239,
"createDate": 1540192956000
}
],
"status": 2,
"signDeadline": null,
"contractStartline": null,
"contractDeadline": null,
"initiateTime": 1540193671000,
"completeTime": 1540193758000,
"transferTimes": 0,
"reason": null,
"rejecter": null,
"docName": "测试指定位置签章日期4",
"isReadOnly": 0,
"isApplication": 0,
"createTime": 1540192956000,
"isOwner": 1,
"payMethod": 0,
"description": null,
"isRealSign": 1,
"evidenceId": null,
"payAccountInfo": "942B054820E94283967F38B98C3899FA",
"payAccountName": "李苏婵",
"lastRemindDate": null,
"isOldVersionData": 0,
"classificationId": "",
"classificationName": null,
"flowSealDataList": [],
"operationLogList": [
{
"accountUid": "942B054820E94283967F38B98C3899FA",
"accountName": "李苏婵",
"accountLogo": "https://esignoss.oss-cn-hangzhou.aliyuncs.com/fd825542-5a2c-4198-b75b-9a02eaab983c?Expires=1540195519&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=wyb8wWfawRNP7Nk8pNB5%2BAMU9k8%3D",
"operation": 1,
"operationName": null,
"transferAccountUid": null,
"transferAccountName": null,
"docId": null,
"flowId": "d9d0c970-b10f-4086-b215-3447c3f2ba05",
"operationDate": 1540193672000,
"sealApplicationList": null
},
{
"accountUid": "942B054820E94283967F38B98C3899FA",
"accountName": "李苏婵",
"accountLogo": "https://esignoss.oss-cn-hangzhou.aliyuncs.com/fd825542-5a2c-4198-b75b-9a02eaab983c?Expires=1540195519&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=wyb8wWfawRNP7Nk8pNB5%2BAMU9k8%3D",
"operation": 1,
"operationName": null,
"transferAccountUid": null,
"transferAccountName": null,
"docId": null,
"flowId": "d9d0c970-b10f-4086-b215-3447c3f2ba05",
"operationDate": 1540193264000,
"sealApplicationList": null
}
],
"receiverList": [
{
"id": "4bbb51c2-fb8d-457b-a76e-18dcc1f56dbb",
"receiverType": 1,
"receiverId": "942B054820E94283967F38B98C3899FA",
"accountType": 1,
"account": "15869154156",
"logo": "https://esignoss.oss-cn-hangzhou.aliyuncs.com/fd825542-5a2c-4198-b75b-9a02eaab983c?Expires=1540195519&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=wyb8wWfawRNP7Nk8pNB5%2BAMU9k8%3D",
"nickname": "李苏婵",
"isSafe": true,
"participantType": 0,
"signStatus": 0,
"isSigned": 0,
"signDate": null,
"viewDate": null,
"signOrder": 1,
"isApplication": 0,
"operationLogDataList": null
},
{
"id": "e74492ff-fe81-43e0-9d72-ea5167bdeb7e",
"receiverType": 2,
"receiverId": "18815289503",
"accountType": 1,
"account": "18815289503",
"logo": "https://esignoss.oss-cn-hangzhou.aliyuncs.com/defaultheadperson.png?Expires=1540195519&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=7qyIhTwU1ZGrFpZvXC8bcDw2zhM%3D",
"nickname": "18815289503",
"isSafe": false,
"participantType": 0,
"signStatus": 0,
"isSigned": 0,
"signDate": null,
"viewDate": null,
"signOrder": 1,
"isApplication": 0,
"operationLogDataList": null
}
]
}
}</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;">signDatePosList</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>