public class CreatePrepareFlowRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
CreatePrepareFlowRequest() |
CreatePrepareFlowRequest(CreatePrepareFlowRequest 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)为必填项。
|
FlowCreateApprover[] |
getApprovers()
Get 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
CcInfo |
getCcInfos()
Get 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
Component |
getComponents()
Get 该字段已废弃,请使用InitiatorComponents
|
Long |
getDeadline()
Get 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
String |
getFlowId()
Get 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
|
String |
getFlowName()
Get 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
CreateFlowOption |
getFlowOption()
Get 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
|
String |
getFlowType()
Get 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
Component[] |
getInitiatorComponents()
Get 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
String |
getIntelligentStatus()
Get 开启或者关闭智能添加填写区:
**OPEN**:开启(默认值)
**CLOSE**:关闭
|
Boolean |
getNeedCreateReview()
Get 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
|
Boolean |
getNeedSignReview()
Get 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
**false**:(默认)不需要审批,直接签署。
**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
UserInfo |
getOperator()
Get 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
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方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
|
String |
getUserFlowTypeId()
Get 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
|
void |
setAgent(Agent Agent)
Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
void |
setApprovers(FlowCreateApprover[] Approvers)
Set 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
void |
setCcInfos(CcInfo CcInfos)
Set 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
void |
setComponents(Component Components)
Set 该字段已废弃,请使用InitiatorComponents
|
void |
setDeadline(Long Deadline)
Set 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
void |
setFlowId(String FlowId)
Set 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
|
void |
setFlowName(String FlowName)
Set 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
void |
setFlowOption(CreateFlowOption FlowOption)
Set 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明
|
void |
setFlowType(String FlowType)
Set 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
void |
setInitiatorComponents(Component[] InitiatorComponents)
Set 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
void |
setIntelligentStatus(String IntelligentStatus)
Set 开启或者关闭智能添加填写区:
**OPEN**:开启(默认值)
**CLOSE**:关闭
|
void |
setNeedCreateReview(Boolean NeedCreateReview)
Set 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
|
void |
setNeedSignReview(Boolean NeedSignReview)
Set 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
**false**:(默认)不需要审批,直接签署。
**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
void |
setOperator(UserInfo Operator)
Set 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
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方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
|
void |
setUserFlowTypeId(String UserFlowTypeId)
Set 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`
|
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, toJsonString
public CreatePrepareFlowRequest()
public CreatePrepareFlowRequest(CreatePrepareFlowRequest source)
public UserInfo getOperator()
public void setOperator(UserInfo Operator)
Operator
- 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`public String getResourceId()
public void setResourceId(String ResourceId)
ResourceId
- 资源id,与ResourceType相对应,取值范围:
public String getFlowName()
public void setFlowName(String FlowName)
FlowName
- 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。public Long getResourceType()
public void setResourceType(Long ResourceType)
ResourceType
- 资源类型,取值有:
public Boolean getUnordered()
public void setUnordered(Boolean Unordered)
Unordered
- 合同流程的签署顺序类型:
public Long getDeadline()
public void setDeadline(Long Deadline)
Deadline
- 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。public String getUserFlowTypeId()
public void setUserFlowTypeId(String UserFlowTypeId)
UserFlowTypeId
- 用户自定义合同类型Id
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
注: `该参数如果和FlowType同时传,以该参数优先生效`public String getFlowType()
public void setFlowType(String FlowType)
FlowType
- 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。public FlowCreateApprover[] getApprovers()
public void setApprovers(FlowCreateApprover[] Approvers)
Approvers
- 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。public String getIntelligentStatus()
public void setIntelligentStatus(String IntelligentStatus)
IntelligentStatus
- 开启或者关闭智能添加填写区:
public Component getComponents()
public void setComponents(Component Components)
Components
- 该字段已废弃,请使用InitiatorComponentspublic CreateFlowOption getFlowOption()
public void setFlowOption(CreateFlowOption FlowOption)
FlowOption
- 发起合同个性化参数
用于满足创建及页面操作过程中的个性化要求
具体定制化内容详见数据接口说明public Boolean getNeedSignReview()
public void setNeedSignReview(Boolean NeedSignReview)
NeedSignReview
- 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
public Boolean getNeedCreateReview()
public void setNeedCreateReview(Boolean NeedCreateReview)
NeedCreateReview
- 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。public String getUserData()
public void setUserData(String UserData)
UserData
- 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。public CcInfo getCcInfos()
public void setCcInfos(CcInfo CcInfos)
CcInfos
- 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。public String getFlowId()
public void setFlowId(String FlowId)
FlowId
- 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`public Agent getAgent()
public void setAgent(Agent Agent)
Agent
- 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。public Component[] getInitiatorComponents()
public void setInitiatorComponents(Component[] InitiatorComponents)
InitiatorComponents
- 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体Copyright © 2024. All rights reserved.