文档变更
2022年时，签署流程归档变为完结签署流程，以便开发者更容易理解，仅中文名称变更，其功能保持不变。
无特殊说明时，文档其他地方以及报错信息中的【归档】字样等同于【完结】。
接口描述
此接口用于完结签署流程，结束后的签署流程不允许再添加、删除签章区域，也不允许撤销签署流程。
注：
（1）签署流程中已添加签署方全部完成签章后才可以完结流程。
（2）完结签署流程后才允许调用【流程文档下载】接口下载已签章的文件。
（3）发起签署时 autoArchive 参数设置为true，全部签章完成时流程将自动完结，无需再调用此接口。
（4）发起签署时 autoArchive 参数设置为false，需要开发者主动调用此接口将签署流程状态变更为已结束。
接口地址&请求方式
接口地址：/v1/signflows/{flowId}/archive
请求方式：PUT
请求头格式
具体请求头格式结构，请点击查看公共参数说明。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 （左右拖动查看完整描述） |
flowId | string | 是 | path | 流程id |
响应参数
参数名称 | 类型 | 必选 | 参数说明 （左右拖动查看完整描述） |
code | int | 是 | 业务码，0表示成功 |
message | string | 否 | 业务信息 |
data | object | 否 | 业务数据 |
请求示例
PUT https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/archive
响应示例
{
"code":0,
"message":"成功",
"data":null
}错误码
错误码 | 错误描述 | 排查方法 （左右拖动查看完整描述） |
1437112 | 非开启状态不允许归档流程 | 只允许结束【签署中】状态的签署流程 |
1437113 | 签署区没有全部完成 | 签署区没有全部完成签署, 不能结束 |
我要纠错