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
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 示例值:查看 |