复制合同模板

更新时间:2024-05-09 17:50:14

接口描述

复制一份相同的模板,原模板中的控件将会一并复制到新的模板。

注意事项:

(1)复制出来新的模板内容与原模板保持一致(模板名称相同);

(2)接口将生成新的模板编号,与新的控件编号;

(3)新模板可以调用【获取编辑合同模板页面】接口,在页面中编辑控件;

(4)仅支持复制API接口中创建的模板,在e签宝官网中创建的模板不可被复制;

(5)pdf模板和html模板均可被复制。

接口地址&请求方法

接口地址:https://{host}/v3/doc-templates/{docTemplateId}/copy

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

参数名称

参数类型

必选

参数位置

参数说明

docTemplateId

string

path

原始合同模板ID

renameDocTemplate

string

body

重命名模板名称(最长64个字)

【注】不传时默认取原模板名称

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。

data(点击“+”展开详情)

string

业务数据

newDocTemplateId

string

新合同模板ID

componentList(点击“+”展开详情)

array

控件列表

originComponentId

string

原始控件ID

newComponentId

string

新控件ID

请求示例

POST https://openapi.esign.cn/v3/doc-templates/061778***701b7/copy

{
  "renameDocTemplate":"新的模板名字"
}
{
    "renameDocTemplate": "新的模板名称"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "newDocTemplateId": "565d746***183f816",
        "componentList": [
            {
                "originComponentId": "d742ba42f***496243a1b",
                "newComponentId": "8dc2c6d***34b172fb"
            },
            {
                "originComponentId": "c35d428de***f416e291fe",
                "newComponentId": "7ffe5a55***28f4f73"
            },
            {
                "originComponentId": "7c86e839d2***c88a66e24",
                "newComponentId": "89fb1dd***33809cfdc"
            }
        ]
    }
}

错误码

点击查看错误码

我要纠错