接口描述
删除指定id的签署区，只能删除未签署状态的签署区。
接口
/v1/signflows/{flowId}/signfields
请求方式
DELETE
请求头
提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
X-Tsign-Open-App-Id | string | 是 | 项目ID | |
Content-Type | string | 是 | application/json;charset=UTF-8 | |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击 | |
Accept | string | 是 | 建议统一填写 */* | |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 | |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。 | |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权，固定值，Signature |
方式二：OAuth2.0鉴权（不推荐使用）
当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 项目ID |
X-Tsign-Open-Token | string | 是 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 |
flowId | string | 是 | path | 流程id | |
signfieldIds | string | 是 | query | 签署区id列表，逗号分割 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码，0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | 示例值 | |
deleteResults | array | 否 | 签署区删除结果集合 | ||
failedReason | string | 否 | 失败原因 | ||
optResult | int | 否 | 操作结果，0-成功，1-失败 | ||
signfieldId | string | 否 | 签署区id | ||
请求示例
DELETE https://openapi.esign.cn/v1/signflows/{flowId}/signfields?signfieldIds=7483308f8b9c465899d9de467a5627ab响应示例
{
"code":0,
"data":{
"deleteResults":[
{
"fail":false,
"optResult":0,
"signfieldId":"7483308f8b9c465899d9de467a5627ab",
"sucess":true
}
]
},
"message":"成功"
}错误码
错误码 | 错误描述 | 解决方案 |
1437102 | 流程已完结 | 已完结的流程不能删除签署区 |
我要纠错