合同管理-用模板添加合同文档

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

contractId

string

合同ID

可选

合同ID与业务ID二选一，不能同时为空

bizId

string

业务ID

可选

合同ID与业务ID二选一，不能同时为空

tenantName

string

子公司名称

可选

若使用业务ID添加合同文件，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

title

string

名称

必需

templateId

string

模板ID

必需

templateParams

array [object {4}]

模板参数

可选

如果是参数模板，则必填（支持格式为文本、单选框、多选框格式的参数）

name

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

参数填写方

可选

documentSort

integer

指定文档排序

可选

示例

{
  "contractId": "{{create_contractId}}",
  "bizId": null,
  "title": "V2添加模板文档",
  "templateId": "2560778409594396776",
  "templateParams": [
    {
      "name": "乙方姓名",
      "value": "张三"
    }
  ]
}

示例代码

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/document/addbytemplate' \
--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 '{
	"contractId": "{{create_contractId}}",
	"bizId": null,
	"title": "V2添加模板文档",
	"templateId": "2560778409594396776",
	"templateParams": [{
		"name": "乙方姓名",
		"value": "张三"
	}]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
  "result": {
    "documentId": "3053227772693446794"
  },
  "code": 0,
  "message": "SUCCESS"
}