接口描述
调用此接口可以向已创建的签署流程中删除待签署文件(仅限流程开启之前允许删除)。
接口地址&请求方法
接口地址:https://{host}/v3/sign-flow/{signFlowId}/unsigned-files?fileIds=xxx1,xxx2
请求方法:DELETE
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
signFlowId | string | 是 | path | 签署流程ID | |
fileIds | string | 是 | query | 待签署文件ID (多个文件请使用英文逗号分隔) |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。 | ||||
data | object | 否 | 业务数据 |
请求示例
DELETE https://openapi.esign.cn/v3/sign-flow/429b1d3**d7e4c0d/unsigned-files?fileIds=97913b**6ccae5da,ac200f0f6a4c4**c35
响应示例
{
"code": 0,
"message": "成功",
"data": null
}