public class CreateDocumentRequest extends AbstractModel
header, skipSign| Constructor and Description |
|---|
CreateDocumentRequest() |
CreateDocumentRequest(CreateDocumentRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
| Modifier and Type | Method and Description |
|---|---|
Agent |
getAgent()
Get 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
String |
getClientToken()
Get 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
|
String[] |
getFileNames()
Get 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
|
String |
getFlowId()
Get 合同流程ID，为32位字符串。
此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
|
FormField[] |
getFormFields()
Get 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。
|
Boolean |
getNeedPreview()
Get 是否为预览模式，取值如下：
**false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
**true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
|
UserInfo |
getOperator()
Get 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
|
Long |
getPreviewType()
Get 预览模式下产生的预览链接类型
**0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
**1** :H5链接 ,点开后在浏览器中展示合同的样子。
注: `1.此参数在NeedPreview 为true时有效`
`2.动态表格控件不支持H5链接方式预览`
|
String |
getTemplateId()
Get 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)
|
void |
setAgent(Agent Agent)
Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
void |
setClientToken(String ClientToken)
Set 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
|
void |
setFileNames(String[] FileNames)
Set 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
|
void |
setFlowId(String FlowId)
Set 合同流程ID，为32位字符串。
此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
|
void |
setFormFields(FormField[] FormFields)
Set 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。
|
void |
setNeedPreview(Boolean NeedPreview)
Set 是否为预览模式，取值如下：
**false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
**true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作
注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
|
void |
setOperator(UserInfo Operator)
Set 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
|
void |
setPreviewType(Long PreviewType)
Set 预览模式下产生的预览链接类型
**0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
**1** :H5链接 ,点开后在浏览器中展示合同的样子。
注: `1.此参数在NeedPreview 为true时有效`
`2.动态表格控件不支持H5链接方式预览`
|
void |
setTemplateId(String TemplateId)
Set 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic CreateDocumentRequest()
public CreateDocumentRequest(CreateDocumentRequest source)
public UserInfo getOperator()
public void setOperator(UserInfo Operator)
Operator - 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。public String getTemplateId()
public void setTemplateId(String TemplateId)
TemplateId - 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)public String getFlowId()
public void setFlowId(String FlowId)
FlowId - 合同流程ID，为32位字符串。
此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。public String[] getFileNames()
public void setFileNames(String[] FileNames)
FileNames - 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。public FormField[] getFormFields()
public void setFormFields(FormField[] FormFields)
FormFields - 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
public Boolean getNeedPreview()
public void setNeedPreview(Boolean NeedPreview)
NeedPreview - 是否为预览模式，取值如下：
public Long getPreviewType()
public void setPreviewType(Long PreviewType)
PreviewType - 预览模式下产生的预览链接类型
public Agent getAgent()
public void setAgent(Agent Agent)
Agent - 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。public String getClientToken()
public void setClientToken(String ClientToken)
ClientToken - 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符Copyright © 2024. All rights reserved.