1、提交审批接口
使用场景:企业对于提交表单等,可以对数据进行加密、解密,保障数据存储安全。
接口地址:自建应用申请相关权限,配置接口地址
请求方式: POST
Content-Type:"application/json"
接口描述:调用外部接口进行加密或者解密
应用权限: 数据安全-数据安全
注意事项:
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 备注 |
---|---|---|---|---|---|
pid | 通过联合登录的第三方用户id | body | 否 | String | 如果是通过第三方平台联合登录的进来的第三方用户 |
userId | 申请人系统账号id | body | 是 | String | 在兔展系统里提交用户的id(userid) |
applicantDeptId | 申请人员工部门id | body | 否 | String | 申请人关联了组织架构的员工时,员工的员工的部门id |
applicantThirdDeptId | 申请人员工第三方部门id | body | 否 | String | 申请人关联了组织架构的员工时,员工的第三方员工部门id |
applicantChannelId | 申请人员工渠道id | body | 否 | String | 申请人关联了组织架构的员工时,兔展系统生成的员工id |
applicant | 申请人员工姓名 | body | 否 | String | 申请人关联了组织架构的员工时,员工的姓名 |
applicantNumber | 申请人员工号 | body | 否 | String | 申请人关联了组织架构的员工时,员工的员工号信息 |
applicantOpenId | 申请人员工openid | body | 否 | String | 申请人关联了组织架构的员工时,员工的openid信息 |
approveTemplateId | 审批模板id | body | 否 | String | 通过审批规则设置中填写的审批模板id,一般是第三方平台对应的审批模板 |
approveOperation | 提交审批和撤回审批 | body | 是 | String | 0提交,4撤回 |
approveId | 审批单号ID | body | 是 | Integer | 兔展平台审批单号id |
approveDetailsDTO | 审批申请详情 | body | 是 | ApproveDetailsDTO | 审批详情 |
approveDetailsDTO
参数名称 | 参数说明 | 请求类型 | 是否必选 | 数据类型 | 备注 |
---|---|---|---|---|---|
approveTarget | 审核对象类型 | body | 是 | String | POINT(用户积分), CONTENT(内容), MARKETING(营销活动), TOUCH(触达任务), MA(流程自动化) |
approveTargetName | 审核对象类型名称 | body | 是 | String | |
approveAction | 审核对象操作类型 | body | 是 | String | ONLINE(上线) OFFLINE(下线) ADD(增加) REDUCE(减少) RELEASE(仅触达) DELETE(删除) |
approveActionName | 审核对象操作类型 | body | 是 | String | |
approveBizId | 审核对象ID | body | 是 | String | 提交审批时,指定的审批对象approve_biz_id。 MA、POINT为json串,其他为对象id。 例如: POINT:{"audienceUserId":905966170514407424,"point":33,"content":"33"} MA: {"processDefId":1012007443046346752} |
approveDetailUrl | 审核对象后台管理地址 | body | 否 | String | 提交审批时,当前的对象类型对应后台系统查看管理设置的入口,如作品编辑的审批查看入口 |
approvePreviewUrl | 审核对象预览地址 | body | 否 | String | 提交审批时,当前的对象类型C端用户的预览地址,只有内容有预览地址 |
createTime | 发起时间 | body | 是 | String | 提交审批时的时间 |
approveContent | 申请理由 | body | 是 | String | 提交审批时用户填写的申请理由信息 |
enclosureDtoList | 申请理由附件信息 | body | 否 | List<ApproveEnclosureDTO> | 提交审批时用户上传的额外附件信息 |
extInfo | 其他额外信息 | body | 否 | String | 系统的其他额外信息内容 |
ApproveEnclosureDTO
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 备注 |
---|---|---|---|---|---|
enclosureType | 附件文件类型 | body | 否 | Integer | 提交审批时用户上传的额外附件类型,附件类型,文件1,图片2 |
enclosureName | 附件名称 | body | 否 | String | 提交审批时用户上传的额外附件类型的文件名称 |
enclosurePath | 附件地址 | body | 否 | String | 提交审批时用户上传的额外附件类型的文件地址 |
返回参数
参数名称 | 参数说明 | 是否必须 | 数据类型 | 备注 |
---|---|---|---|---|
code | 返回编码 | 是 | String | 200表成功,其他不通过 |
msg | 返回信息 | 否 | String | 信息提示 |
thirdApproveId | 第三方审批单号,成功必传 | 是 | String | 审批提交成功后,返回的第三方系统的审批编号 |
2、更新审批接口
使用场景:企业对于提交表单等,可以对数据进行加密、解密,保障数据存储安全。
接口地址:自建应用申请相关权限,配置接口地址
请求方式: POST
Content-Type:"application/json"
接口描述:调用外部接口进行加密或者解密
应用权限: 数据安全-数据安全
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必要 | 数据类型 | 备注 |
---|---|---|---|---|---|
approveId | 审批单号 | body | 否 | String | 兔展系统生成的审批单号信息 |
approveThirdId | 第三方系统的审批单号 | body | 是 | String | 审批提交成功后,返回的第三方系统的审批编号 |
返回参数
参数名称 | 参数说明 | 请求类型 | 是否必填 | 数据类型 | 备注说明 |
---|---|---|---|---|---|
approveThirdId | 第三方系统的审批单号 | body | 是 | String | 审批提交成功后,返回的第三方系统的审批编号 |
approveResult | 审批单结果状态 | body | 是 | String | 在第三方系统审批完成后,审批单的状态信息,1审批未结束,2审批完成 |
approveNodeList | 审批节点信息 | body | 是 | ApproveNodeDTO | 会有多个节点信息 |
ApproveNodeDTO
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 备注说明 |
---|---|---|---|---|---|
approverNum | 审批员工号 | body | 是 | List<String> | 内部系统的员工号信息 |
approverName | 审批员工姓名 | body | 否 | List<String> | 内部系统的员工号姓名信息 |
nodeStatus | 审批节点状态 | body | 是 | String | 在第三方系统审批完成后,审批单节点的状态信息,分为1未审批(审批中),2审批通过,3审批驳回 |
nodeStatusName | 审批节点状态名称 | body | 否 | String | 在第三方系统审批完成后,审批单节点的状态信息的中文名称,未审批(审批中),审批通过,审批驳回 |
approveOpinion | 审批员工意见 | body | 是 | String | 审批中回复的意见信息 |
approveTime | 审批时间 | body | 是 | Date | 审批的操作时间 |
3、订阅系统默认审批单信息接口
使用场景:企业对于提交表单等,可以对数据进行加密、解密,保障数据存储安全。
接口地址:自建应用申请相关权限,配置接口地址
请求方式: POST
Content-Type:"application/json"
接口描述:调用外部接口进行加密或者解密
应用权限: 数据安全-数据安全
请求实体
参数名字 | 参数名称 | 参数说明 | 请求类型 | 值域 | 是否必填 | 备注说明 |
---|---|---|---|---|---|---|
审批单号ID | approveId | Integer | 是 | 当前系统自动审批的审批单号id | ||
审批操作类型 | approveOperation | String | 0(提交),4(撤回) | 是 | 分为提交审批和撤回审批 | |
申请人系统账号id | userId | String | 是 | 在兔展系统里提交用户的id | ||
申请人员工姓名 | applicant | String | 否 | 申请人关联了组织架构的员工时,员工的姓名 | ||
申请人员工id | applicantChannelId | String | 渠道id | 否 | 申请人关联了组织架构的员工时,兔展系统生成的员工id, | |
申请人员工openid | applicantOpenId | String | 否 | 申请人关联了组织架构的员工时,员工的openid信息 | ||
申请人员工号 | applicantNumber | String | thirduserid | 否 | 申请人关联了组织架构的员工时,员工的员工号信息 | |
申请人员工部门id | applicantDeptId | String | 否 | 申请人关联了组织架构的员工时,员工的员工的部门id | ||
审批申请详情 | approveDetailsDTO | ApproveDetailsDTO | 是 | |||
└审核对象类型 | approveTarget | String | POINT, CONTENT, MARKETING, TOUCH, MA | 是 | 提交审批时,当前的对象类型,需要枚举,如作品、积分、触达、流程自动化 | |
└审核对象类型名称 | approveTargetName | String | 用户积分 内容 营销活动 触达任务 流程自动化 | 是 | 提交审批时,当前的对象操作类型,需枚举,如作品的发布、作品的删除、流程自动化的发布 | |
└审核对象ID | approveBizId | String | 对应approve里的bizid | 是 | 提交审批时,指定的审批对象approve_biz_id。 MA、POINT为json串,其他为对象id。 例如: POINT:{"audienceUserId":905966170514407424,"point":33,"content":"33"} MA: {"processDefId":1012007443046346752} | |
└审核对象操作类型 | approveAction | String | ONLINE OFFLINE ADD REDUCE RELEASE(仅触达) DELETE | 是 | 提交审批时,当前的对象类型 | |
└审核对象操作类型名称 | approveActionName | String | 发布 下线 增加 减少 发布(仅限触达) 删除 | 是 | 提交审批时,当前的对象类型对应的中文名称 | |
└审核对象后台管理地址 | approveDetailUrl | String | 否 | 提交审批时,当前的对象类型对应后台系统查看管理设置的入口,如作品编辑的审批查看入口 | ||
└审核对象预览地址 | approvePreviewUrl | String | 只有内容有预览地址 | 否 | 提交审批时,当前的对象类型C端用户的预览地址 | |
└发起时间 | createTime | Timestamp | 是 | 提交审批时的时间 | ||
└申请理由文本信息 | approveContent | String | 是 | 提交审批时用户填写的申请理由信息 | ||
└申请理由附件信息 | enclosureDtoList | List<ApproveEnclosureDTO> | 否 | 提交审批时用户上传的额外附件信息 | ||
└└申请理由附件文件类型 | enclosureType | Integer | 附件类型,文件1,图片2 | 否 | 提交审批时用户上传的额外附件类型,例如图片、音频、视频、文件 | |
└└申请理由附件名称 | enclosureName | String | 否 | 提交审批时用户上传的额外附件类型的文件名称 | ||
└└申请理由附件地址 | enclosurePath | String | 否 | 提交审批时用户上传的额外附件类型的文件地址 | ||
└其他额外信息 | extInfo | String | 否 | 系统的其他额外信息内容 | ||
审批单结果状态 | approveResult | String | 是 | 在兔展审批系统审批完成后,审批单的状态信息,分为审批中、审批通过、审批驳回 | ||
审批节点信息 | approveNodeList | List<ApproveNodeDTO> | 是 | 会有多个节点信息(如果有多个员工,则该行是列表) | ||
└└审批员工号 | approverNum | List<String> | 否 | 内部系统的员工号信息(如果有多个员工,则该行是列表。 此列为空或者员工号为空: 1、如果提交审批人不在组织架构内,则是自己审批; 2、如果审批员工不在组织架构或者员工号(thirduserid)为空; | ||
└└审批节点状态 | nodeStatus | String | 是 | 在第三方系统审批完成后,审批单的状态信息,分为审批中、审批通过、审批驳回 | ||
└└审批节点状态名称 | nodeStatusName | String | 否 | 在第三方系统审批完成后,审批单的状态信息的中文名称 | ||
└└审批员工意见 | approveOpinion | String | 是 | 审批中回复的意见信息 | ||
└└审批时间 | approveTime | Date | 是 | 审批的操作时间 |
响应
参数名字 | 参数 | 类型 | 是否必选 | 备注 |
---|---|---|---|---|
第三方审批单号 | approveId | String | 是 | 由于是推送给三方的,兔展并不关心是否成功,不会进行重试 |