模板管理-编辑模板

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

templateId

string

模板ID

必需

title

string

修改的模板名称

可选

参数为空时不作处理

templateParam

array[object (TemplateParamRequest) {7}]

修改的模板参数列表

可选

name

string

要修改的参数名称

必需

required

boolean

设置参数是否必填

可选

defaultValue

string

设置参数默认值

可选

单选多选不支持设置默认值，时间格式默认值需以'yyyy-MM-dd'格式提供

description

string

设置参数描述值

可选

value

string

文档参数值

必需

单行文本字数限制：1000 当使用html模板时，合同文档参数的value值说明： > 参数类型是单行文本时，value大小不超过1000; > 参数类型是日期时，value格式为：yyyy-MM-dd，如：2019-06-04; > 参数类型是身份证号，value只能是15或18位的数字或字母，如：123456789123456789; > 参数类型是单选，value只能是单选的选项,如：val1; > 参数类型是多选，value只能是多选的选项，多个value用逗号隔开，如：val1,val2; > 参数类型是表格，value是一个Map（键值对）数组，每个Map对应表格的每行，Map的key和value对应列名和值，示例如下： [{"column1":"1","column2":"2","column3":"3","column4":"4"},{"column1":"5","column2":"6","column3":"7","column4":"8"}]表示一个2行4列的表格。 > 参数类型是图片，value是图片的base64格式加前缀「data:image/png;base64,」，其中image/png为实际的图片格式，示例如下：data:image/png;base64,/9j/4AAQSk...

readOnly

string

参数是否只读

可选

默认为false;传入true时，在页面上进行合同填参时该参数不可编辑

signatoryId

string

参数填写方

可选

managers

array [object {2}]

设置具体公司内的人员作为模板管理员

可选

替换此模板原有管理员，参数为空时不作处理

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

range

array [object {2}]

模板使用范围

可选

自定义设置具体的人，替换此模板原有使用人，参数为空时不作处理

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

示例

{
    "templateId":"{{wordTemplateId}}",
    "title" : "模板{{__Random(10,99,)}}",
    "templateParam" : [
        {
            "name":"文本",
            "defaultValue":"修改内容{{__Random(10,99,)}}",
            "required":false
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/template/edit' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId":"{{wordTemplateId}}",
    "title" : "模板{{__Random(10,99,)}}",
    "templateParam" : [
        {
            "name":"文本",
            "defaultValue":"修改内容{{__Random(10,99,)}}",
            "required":false
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
    "code": 0,
    "message": "SUCCESS"
}