接口描述
当模板需要修改,可以通过原模板ID再次获取模板设置页面进行编辑。
【注】:
1.必须确保企业用户已授予资源管理权限(manage_org_resource),才可以获取对应企业的编辑流程模板页面,点击跳转企业授权接口
2.模板需处于停用状态,才可以编辑流程模板,点击跳转停用流程模板接口
接口地址&请求方法
接口地址:https://{host}/v3/sign-templates/{signTemplateId}/sign-template-edit-url
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
signTemplateId | string | 是 | path | 流程模板ID |
orgId | string | 是 | body | 机构用户ID 【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询 |
transactorPsnId | string | 是 | body | 经办人个人用户ID 【注】通过 【查询企业成员列表】 查询企业成员的账号ID(psnId),经办人必须有模板操作权限,建议直接使用管理员账号 |
redirectUrl | string | 是 | body | 编辑完成后重定向地址 (最长1024字符) |
hiddenOriginComponents | boolean | 否 | body | 是否隐藏原始控件,默认false true-隐藏 false-不隐藏 |
customComponentGroups | list | 否 | body | 要展示的自定义控件组ID列表 自定义控件组请使用接口:【创建控件组】 |
customComponents | list | 否 | body | 要展示的自定义控件ID列表 自定义控件请使用接口:【创建自定义业务控件】 |
uneditableFields | list | 否 | body | 禁止用户在页面上修改或追加的内容
|
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | |
data(点击“+”展开详情) | object | 否 | 业务数据 | |
signTemplateEditUrl | string | 是 | 编辑流程模板页面链接(该地址无需登录,有效期30分钟) |
请求示例
POST https://openapi.esign.cn/v3/sign-templates/b7018f7e130***978925f2/sign-template-edit-url
{
"orgId": "6b498644****11b590803b800",
"transactorPsnId": "498644******b590803b120",
"redirectUrl": "https://****.cn"
}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"signTemplateEditUrl": "https://smlh5.esign.cn/auth/guide?loginId=1cfb81fe-3***-4042-a8**-8a39b1***48"
}
}