数据结构

最近更新时间: 2024-12-21 13:01:30

StageParam

stage参数

被如下接口引用:CreateCustomerFlow、CreateFlow、ModifyApprovalFlow、QueryCurrApprovalDetail、QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
StageID 是 否 Uint64 stage id
示例值:
Name 是 否 String 节点名称
示例值:
SingleSeal 是 否 Bool false 会签, true或签
示例值:
Approvers 是 否 Array of String 审批租户uin列表
示例值:
SerialNumber 是 否 Uint64 节点序号
示例值:
Seals 是 否 Array of SealParam Seals
示例值:查看
StageStatus 是 否 Int64 StageStatus
示例值:
ApproverInfo 是 否 Array of ApproverInfoParam ApproverInfo
示例值:查看

UserScope

作用用户范围

被如下接口引用:CreateCustomerFlow、CreateFlow、ModifyApprovalFlow

名称 必选 允许NULL 类型 描述
Uin 是 否 String -1,全体租户或具体租户uin
示例值:
IsSubAccount 是 否 Bool 是否为子账号
示例值:

ApprovalPaperSet

审批单列表信息

被如下接口引用:QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
PaperSet 是 是 Array of ApprovalPaperAttr 审批单列表
示例值:查看
Total 是 否 String 总数
示例值:

ApprovalError

ApprovalError

被如下接口引用:

名称 必选 允许NULL 类型 描述
Code 是 否 String 错误码
示例值:
Message 是 否 String 错误信息
示例值:

ApproverAttr

审批人信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
ApproverStatus 是 否 String 审批人状态,Normal:正常,Unknown:异常
示例值:
ApproverUin 是 否 String 审批人uin
示例值:
ApproverUserName 是 否 String 审批人用户名
示例值:

ApiInfo

yunapi v3接口 三元组参数

被如下接口引用:QueryApprovalFlowStatus、QueryCustomerApprovalDoc

名称 必选 允许NULL 类型 描述
Action 是 否 String 接口名
示例值:
Module 是 否 String 模块名
示例值:
Version 是 否 String 版本
示例值:

SealParam

SealParam for user approve record

被如下接口引用:CreateCustomerFlow、CreateFlow、ModifyApprovalFlow、QueryCurrApprovalDetail、QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
ID 是 否 Int64 ID
示例值:
PaperID 是 否 Int64 审批单 id
示例值:
StageSerialNum 是 否 Int64 审批阶段数量
示例值:
OpUin 是 否 String OpUin
示例值:
ApproveTime 是 否 Datetime_iso ApproveTime
示例值:
Operate 是 否 Int64 Operate
示例值:
Opinion 是 否 String Opinion
示例值:
Request 否 是 String Request
示例值:

IsOpenAttr

是否开启审批流

被如下接口引用:QueryApprovalFlowStatus

名称 必选 允许NULL 类型 描述
IsOpen 是 否 Bool 是否存在已开启的审批流, true:存在, false: 不存在
示例值:

Scope

作用用户范围

被如下接口引用:CreateCustomerFlow、CreateFlow、ModifyApprovalFlow

名称 必选 允许NULL 类型 描述
ActionID 是 否 Uint64 业务接口id
示例值:
Users 是 否 Array of UserScope 作用用户列表
示例值:查看

PaperBase

审批单基础属性

被如下接口引用:QueryCurrApprovalDetail

名称 必选 允许NULL 类型 描述
FlowVersion 是 否 Int64 FlowVersion
示例值:
FlowDescription 否 否 String 关联审批流描述信息
示例值:
Action 是 否 String 对应云api接口
示例值:
CTime 是 否 Datetime 申请时间
示例值:
PaperID 是 否 Int64 审批单 id
示例值:
FlowID 是 否 Int64 审批流 id
示例值:
ParentID 否 否 Int64 上层审批单ID
示例值:
CurrStageNum 是 否 Int64 当前审批节点
示例值:
Status 是 否 Int64 审批单状态,0:审批单初始化,1:审批进行中,11:申请撤销,12:审批拒绝, 14: 审批通过,15:自动同意
示例值:
Applicant 是 否 String 申请人
示例值:
OwnerAccount 否 否 String 主账号名称
示例值:
OwnerUin 是 否 String 主账号uIn
示例值:
Reason 否 否 String  审批理由
示例值:
ApplicantUin 是 否 String 申请人 uin
示例值:
RequestBody 否 否 Array of String 请求 body
示例值:
CallbackStatus 是 否 Int64 审批通过后,回调状态. 0:未开始, 100:回调成功,101:回调失败
示例值:
CallBackResult 否 否 String CallBackResult
示例值:
ActionName 是 否 String 审批业务中文名
示例值:
Schema 否 否 String Schema
示例值:
ModuleName 是 否 String 审批业务对应云API模块中文名
示例值:
ProductName 是 否 String 云产品名称
示例值:
ActionDescription 是 否 String 审批业务描述信息
示例值:
Stages 否 否 Array of StageParam 对应审批节点信息
示例值:查看
Seals 否 是 Array of SealParam 已审批信息
示例值:查看
ActionID 是 否 Int64 审批业务ID
示例值:

QueryActionParma

查询action

被如下接口引用:QueryActionSet

名称 必选 允许NULL 类型 描述
ActionIDs 否 否 Array of Uint64 id 列表
示例值:
Action 否 否 String action名称
示例值:
Module 否 否 String 所属模块
示例值:
Limit 是 否 Uint64 页数
示例值:
Offset 是 否 Uint64 偏移量
示例值:
ActionName 否 否 String 业务名称
示例值:
ModuleName 否 否 String 接口对应模块(中文名)
示例值:
YunProductName 否 否 String 接口对应产品(中文名)
示例值:
Sort 否 否 Order 排序字段
示例值:查看
Filters 否 否 Array of FilterAttr 过滤条件列表
示例值:查看

ApprovalPaperAttr

审批单属性

被如下接口引用:QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
Action 是 否 String 对应云api接口
示例值:
ActionDescription 是 否 String 审批业务描述信息
示例值:
ActionID 是 否 String 审批业务ID
示例值:
ActionName 是 否 Int64 审批业务中文名
示例值:
Applicant 是 否 String 申请人
示例值:
ApplicantUin 是 否 String 申请人uin
示例值:
CTime 是 否 String 申请时间
示例值:
CallbackStatus 是 否 Int64 审批通过后,回调状态. 0:未开始, 100:回调成功,101:回调失败
示例值:
CurrStageNum 是 否 Int64 当前审批节点
示例值:
FlowDescription 否 否 String 关联审批流描述信息
示例值:
FlowID 是 否 Int64 审批流ID
示例值:
ModuleName 是 否 String 审批业务对应云API模块中文名
示例值:
OwnerAccount 否 否 String 主账号名称
示例值:
OwnerUin 是 否 String 主账号uIn
示例值:
PaperID 是 否 Int64 审批单ID
示例值:
ParentID 否 否 Int64 上层审批单ID
示例值:
ProductName 是 否 String 云产品名称
示例值:
Reason 否 否 String 审批理由
示例值:
Schema 否 否 String schema
示例值:
RequestBody 否 是 String 请求参数,此处无法按云API3规范
示例值:
Seals 否 是 SealParam 已审批信息
示例值:查看
Status 否 否 Int64 审批单状态,0:审批单初始化,1:审批进行中,11:申请撤销,12:审批拒绝, 14: 审批通过,15:自动同意
示例值:
Stages 否 是 Array of StageParam 对应审批节点信息
示例值:查看
CallBackResult 否 否 String CallBackResult
示例值:
FinalStatus 否 否 Uint64 最终审批单状态
示例值:
RelatedPapers 否 否 Array of ApprovalPaperAttr 关联的审批单信息
示例值:查看
Category 否 否 Uint64 审批单类型,1: 由页面触发,2: 合并申请单
示例值:
LastRemindTime 否 是 String 最后一次提醒审批人的时间
示例值:

ApproverInfoParam

ApproverInfoParam

被如下接口引用:CreateCustomerFlow、CreateFlow、ModifyApprovalFlow、QueryCurrApprovalDetail、QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
ApproverUin 否 否 String ApproverUin
示例值:
ApproverUserName 否 否 String ApproverUserName
示例值:
ApproverStatus 否 否 String ApproverStatus
示例值:

FilterAttr

过滤参数

被如下接口引用:DescribeFlowSet、QueryActionSet

名称 必选 允许NULL 类型 描述
Name 是 否 String 参数名称
示例值:
Operator 是 否 String 操作符,支持equal, like
示例值:
Value 是 否 String 参数值
示例值:

Order

排序字段信息

被如下接口引用:DescribeFlowSet、GetApprovedSet、QueryActionSet、QueryApplicationForm、QueryCurrApprovalDoc、QueryCustomerApprovalDoc、QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
Field 是 否 String 排序字段英文名
示例值:
IsDesc 是 否 Bool 是否降序,true-升序,false-降序
示例值: