数据结构

最近更新时间: 2026-04-10 00:05:07

ApiInfo

yunapi v3接口 三元组参数

被如下接口引用:QueryApprovalFlowStatus、QueryCustomerApprovalDoc

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

FilterAttr

过滤参数

被如下接口引用:DescribeFlowSet、QueryActionSet

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

FlowBaseAttr

审批流基础属性

被如下接口引用:DescribeFlowSet、QueryCustomerActionScope

名称 必选 允许NULL 类型 描述
FlowID Int64 审批流 ID
示例值: 18
Platform String 平台
示例值: tcloud
Name String 审批流名称
示例值: Name
Description String 审批流描述
示例值: Description
SchemaProps String SchemaProps
示例值: SchemaProps
Activated Bool 是否启用
示例值: true
OwnerUin String 主账号 Uin
示例值: 130000000013
CreateUin String 创建人 Uin
示例值: 130000000013
CTime Datetime_iso 创建日期
示例值: 2025-04-25T17:12:03+08:00
UpTime Datetime_iso 修改日期
示例值: 2025-04-25T17:12:03+08:00
Version Int64 版本
示例值: 12
CreateUser String 创建用户
示例值: Lucy
ActionIDs Array of Int64 审批业务 ID
示例值: [1,2,3]
AllowSms Bool 是否允许短信审批
示例值: false
AutoReject Bool 是否自动拒绝
示例值: false
Remark String 备注
示例值: Remark

FlowsData

审批流列表

被如下接口引用:DescribeFlowSet

名称 必选 允许NULL 类型 描述
Flows Array of FlowBaseAttr 审批流列表
示例值:查看
Total Int64 总数
示例值: 100

Order

排序字段信息

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

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

SealParam

SealParam for user approve record

被如下接口引用:CreateCustomerFlow、GetApprovedSet、GetFlowDetail、ModifyApprovalFlow、QueryApplicationForm、QueryCurrApprovalDetail、QueryCurrApprovalDoc、QueryCustomerApprovalDetail、QueryCustomerApprovalDoc、QueryPendingApprovalDoc

名称 必选 允许NULL 类型 描述
ID Int64 ID
示例值: 1
PaperID Int64 审批单 id
示例值: 1
StageSerialNum Int64 审批阶段顺序
示例值: 1
OpUin String OpUin
示例值: 130000000281
ApproveTime Datetime_iso ApproveTime
示例值: 2024-08-03T12:00:00+08:00
Operate Int64 Operate
示例值: 14
Opinion String Opinion
示例值: Approved
Request String Request
示例值: json RawRequest

UserScope

作用用户范围

被如下接口引用:CreateCustomerFlow、GetFlowDetail、ModifyApprovalFlow、QueryCustomerActionScope

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

ActionAttr

审批业务

被如下接口引用:QueryActionSet

名称 必选 允许NULL 类型 描述
Action String 审批业务接口名称
示例值: AddMachine
Module String 审批业务模块
示例值: cvm
Version String 审批业务版本
示例值: 2022-02-02
ActionID Int64 审批业务 ID
示例值: 1
Description String 审批业务描述
示例值: AddMachine
Schema String Schema
示例值: Schema
ActionName String 审批业务接口名
示例值: AddMachine
ModuleName String 审批业务模块名
示例值: cvm
YunProductName String 审批业务云产品名称
示例值: cvm
Category String 类型
示例值: 6
Creator String 创建人
示例值: admin
UpdateUser String 修改人
示例值: Lucy
CreateUserUin String 创建人 Uin
示例值: 130000000281
UpdateUserUin String 修改人 Uin
示例值: 130000000281
CreateTime Datetime_iso 创建日期
示例值: 2024-08-03T12:00:00+08:00
UpdateTime Datetime_iso 修改日期
示例值: 2024-08-03T12:00:00+08:00
Origin Int64 来源
示例值: 1
Type Int64 类型
示例值: 6
JsonPath String JsonPath
示例值: JsonPath

ApprovalPaperSet

审批单列表信息

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

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

ApproverInfoParam

ApproverInfoParam

被如下接口引用:CreateCustomerFlow、GetApprovedSet、GetFlowDetail、ModifyApprovalFlow、QueryApplicationForm、QueryCurrApprovalDetail、QueryCurrApprovalDoc、QueryCustomerApprovalDetail、QueryCustomerApprovalDoc、QueryPendingApprovalDoc

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

IsOpenAttr

是否开启审批流

被如下接口引用:QueryApprovalFlowStatus

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

Scope

作用用户范围

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

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

ActionRelatedInfo

审批业务关联审批流相关信息

被如下接口引用:QueryCustomerActionScope

名称 必选 允许NULL 类型 描述
Users Array of UserScope 关联的用户信息,-1代表全体租户
示例值:查看
Flow Array of FlowBaseAttr 关联的审批流信息
示例值:查看
ActionID Int64 审批业务ID
示例值: 1

ApprovalPaperAttr

审批单属性

被如下接口引用:GetApprovedSet、QueryApplicationForm、QueryCurrApprovalDetail、QueryCurrApprovalDoc、QueryCustomerApprovalDetail、QueryCustomerApprovalDoc、QueryPendingApprovalDoc

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

QueryActionsOutput

QueryActionsOutput

被如下接口引用:QueryActionSet

名称 必选 允许NULL 类型 描述
Total Int64 总数
示例值: 100
Actions Array of ActionAttr 审批业务列表
示例值:查看

FlowDetail

审批流详情

被如下接口引用:GetFlowDetail

名称 必选 允许NULL 类型 描述
FlowID Int64 审批流 ID
示例值: 18
Platform String 平台
示例值: tcloud
Name String 审批流名称
示例值: Name
Description String 审批流描述
示例值: Description
SchemaProps String SchemaProps
示例值: SchemaProps
Activated Bool 是否启用
示例值: true
OwnerUin String 主账号 Uin
示例值: 130000000013
CreateUin String 创建人 Uin
示例值: 130000000013
CTime Datetime_iso 创建日期
示例值: 2025-04-25T17:12:03+08:00
UpTime Datetime_iso 修改日期
示例值: 2025-04-25T17:12:03+08:00
Version Int64 版本
示例值: 12
CreateUser String 创建用户
示例值: Lucy
ActionIDs Array of Int64 审批业务 ID
示例值: [1,2,3]
AllowSms Bool 是否允许短信审批
示例值: false
AutoReject Bool 是否自动拒绝
示例值: false
Remark String 备注
示例值: Remark
Stages Array of StageParam 审批节点列表
示例值:查看
Scopes Array of Scope 审批作用范围列表
示例值:查看

QueryActionParma

查询action

被如下接口引用:QueryActionSet

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

StageParam

stage参数

被如下接口引用:CreateCustomerFlow、GetApprovedSet、GetFlowDetail、ModifyApprovalFlow、QueryApplicationForm、QueryCurrApprovalDetail、QueryCurrApprovalDoc、QueryCustomerApprovalDetail、QueryCustomerApprovalDoc、QueryPendingApprovalDoc

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