public class CreateMiniAppPrepareFlowRequest extends AbstractModel
header, skipSign| Constructor and Description |
|---|
CreateMiniAppPrepareFlowRequest() |
CreateMiniAppPrepareFlowRequest(CreateMiniAppPrepareFlowRequest 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）为必填项。
|
MiniAppCreateApproverInfo[] |
getApprovers()
Get 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息。
|
CcInfo[] |
getCcInfos()
Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注：暂不支持通过NotifyType参数控制抄送人通知方式**
|
Long |
getDeadlineAfterStartDays()
Get 合同发起后经过多少天截止（1-30天可选），默认7天
|
String |
getFlowName()
Get 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。
|
MiniAppCreateFlowOption |
getFlowOption()
Get 发起合同个性化参数
用于满足小程序合同创建的个性化要求
具体定制化内容详见数据接口说明
|
UserInfo |
getOperator()
Get 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
MiniAppCreateFlowPageOption |
getPageOption()
Get 发起合同小程序页面个性化参数
用于满足小程序合同创建页面的个性化要求 具体定制化内容详见数据接口说明
|
String |
getResourceId()
Get 资源id，与ResourceType相对应，取值范围：
文件Id（通过UploadFiles获取文件资源Id）
模板Id（通过控制台创建模板后获取模板Id）
注意：需要同时设置 ResourceType 参数指定资源类型
|
Long |
getResourceType()
Get 资源类型，取值有：
**1**：模板
**2**：文件
|
Boolean |
getUnordered()
Get 合同流程的签署顺序类型：
**false**：(默认)有序签署, 本合同多个参与人需要依次签署
**true**：无序签署, 本合同多个参与人没有先后签署限制
注：仅在文件发起模式下设置有效，模板发起以模板配置为准**
|
String |
getUserData()
Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000 长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
|
String |
getUserFlowTypeId()
Get 用户自定义合同类型Id 该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取
|
void |
setAgent(Agent Agent)
Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
void |
setApprovers(MiniAppCreateApproverInfo[] Approvers)
Set 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息。
|
void |
setCcInfos(CcInfo[] CcInfos)
Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注：暂不支持通过NotifyType参数控制抄送人通知方式**
|
void |
setDeadlineAfterStartDays(Long DeadlineAfterStartDays)
Set 合同发起后经过多少天截止（1-30天可选），默认7天
|
void |
setFlowName(String FlowName)
Set 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。
|
void |
setFlowOption(MiniAppCreateFlowOption FlowOption)
Set 发起合同个性化参数
用于满足小程序合同创建的个性化要求
具体定制化内容详见数据接口说明
|
void |
setOperator(UserInfo Operator)
Set 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
void |
setPageOption(MiniAppCreateFlowPageOption PageOption)
Set 发起合同小程序页面个性化参数
用于满足小程序合同创建页面的个性化要求 具体定制化内容详见数据接口说明
|
void |
setResourceId(String ResourceId)
Set 资源id，与ResourceType相对应，取值范围：
文件Id（通过UploadFiles获取文件资源Id）
模板Id（通过控制台创建模板后获取模板Id）
注意：需要同时设置 ResourceType 参数指定资源类型
|
void |
setResourceType(Long ResourceType)
Set 资源类型，取值有：
**1**：模板
**2**：文件
|
void |
setUnordered(Boolean Unordered)
Set 合同流程的签署顺序类型：
**false**：(默认)有序签署, 本合同多个参与人需要依次签署
**true**：无序签署, 本合同多个参与人没有先后签署限制
注：仅在文件发起模式下设置有效，模板发起以模板配置为准**
|
void |
setUserData(String UserData)
Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000 长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
|
void |
setUserFlowTypeId(String UserFlowTypeId)
Set 用户自定义合同类型Id 该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取
|
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 CreateMiniAppPrepareFlowRequest()
public CreateMiniAppPrepareFlowRequest(CreateMiniAppPrepareFlowRequest source)
public UserInfo getOperator()
public void setOperator(UserInfo Operator)
Operator - 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`public Long getResourceType()
public void setResourceType(Long ResourceType)
ResourceType - 资源类型，取值有：
public String getResourceId()
public void setResourceId(String ResourceId)
ResourceId - 资源id，与ResourceType相对应，取值范围：
public String getFlowName()
public void setFlowName(String FlowName)
FlowName - 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。public Agent getAgent()
public void setAgent(Agent Agent)
Agent - 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。public MiniAppCreateApproverInfo[] getApprovers()
public void setApprovers(MiniAppCreateApproverInfo[] Approvers)
Approvers - 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息。public CcInfo[] getCcInfos()
public void setCcInfos(CcInfo[] CcInfos)
CcInfos - 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注：暂不支持通过NotifyType参数控制抄送人通知方式**public Boolean getUnordered()
public void setUnordered(Boolean Unordered)
Unordered - 合同流程的签署顺序类型：
public Long getDeadlineAfterStartDays()
public void setDeadlineAfterStartDays(Long DeadlineAfterStartDays)
DeadlineAfterStartDays - 合同发起后经过多少天截止（1-30天可选），默认7天public String getUserFlowTypeId()
public void setUserFlowTypeId(String UserFlowTypeId)
UserFlowTypeId - 用户自定义合同类型Id 该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取public MiniAppCreateFlowOption getFlowOption()
public void setFlowOption(MiniAppCreateFlowOption FlowOption)
FlowOption - 发起合同个性化参数
用于满足小程序合同创建的个性化要求
具体定制化内容详见数据接口说明public MiniAppCreateFlowPageOption getPageOption()
public void setPageOption(MiniAppCreateFlowPageOption PageOption)
PageOption - 发起合同小程序页面个性化参数
用于满足小程序合同创建页面的个性化要求 具体定制化内容详见数据接口说明public String getUserData()
public void setUserData(String UserData)
UserData - 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000 长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。Copyright © 2025. All rights reserved.