Data structure

Last Updated At: 2026-08-02 00:05:10

FlowBaseAttr

Approval process basic attribute.

Referenced by the following interfaces: DescribeFlowSet, QueryCustomerActionScope

name required NULL allowed type description
FlowID no no Int64 Approval process ID.
Example: 18
Platform no no String Platform
Example: tcloud
Name no no String Approval flow name
Example: Name
Description no no String Description of the approval flow.
Example: Description
SchemaProps no no String SchemaProps
Example: SchemaProps
Activated no no Bool Enable/Disable
Example: true
OwnerUin no no String Owner UIN
Example: 130000000013
CreateUin no no String Creator UIN.
Example: 130000000013
CTime no no Datetime_iso Creation date
Example: 2025-04-25T17:12:03+08:00
UpTime no no Datetime_iso Modification Date
Example: 2025-04-25T17:12:03+08:00
Version no no Int64 Version.
Example: 12
CreateUser no no String Create User
Example: Lucy
ActionIDs no no Array of Int64 Approval business ID.
Example: [1,2,3]
AllowSms no no Bool Whether to allow approval via SMS.
Example: false
AutoReject no no Bool Whether to automatically reject.
Example: false
Remark no no String Remarks
Example: Remark

SealParam

SealParam for user approve record

Referenced by the following interfaces: CreateCustomerFlow, GetApprovedSet, GetFlowDetail, ModifyApprovalFlow, QueryApplicationForm, QueryCurrApprovalDetail, QueryCurrApprovalDoc, QueryCustomerApprovalDetail, QueryPendingApprovalDoc

name required NULL allowed type description
ID yes no Int64 ID
Example: 1
PaperID yes no Int64 Approval Form ID
Example: 1
StageSerialNum yes no Int64 Approval phase sequence.
Example: 1
OpUin yes no String OpUin
Example: 130000000281
ApproveTime yes no Datetime_iso ApproveTime
Example: 2024-08-03T12:00:00+08:00
Operate yes no Int64 Operate
Example: 14
Opinion yes no String Opinion
Example: Approved
Request no yes String Request
Example: json RawRequest

ActionAttr

Approval business.

Referenced by the following interfaces: QueryActionSet

name required NULL allowed type description
Action no no String Approval business API name.
Example: AddMachine
Module no no String Approval business module.
Example: cvm
Version no no String Approval business version.
Example: 2022-02-02
ActionID no no Int64 Approval business ID.
Example: 1
Description no no String Approval business description
Example: AddMachine
Schema no no String Schema
Example: Schema
ActionName no no String Approval business API name.
Example: AddMachine
ModuleName no no String Approval business module name.
Example: cvm
YunProductName no no String Approval business cloud product name.
Example: cvm
Category no no String Type
Example: 6
Creator no no String Creator
Example: admin
UpdateUser no no String Modifier
Example: Lucy
CreateUserUin no no String Creator UIN.
Example: 130000000281
UpdateUserUin no no String Modifier UIN.
Example: 130000000281
CreateTime no no Datetime_iso Creation date
Example: 2024-08-03T12:00:00+08:00
UpdateTime no no Datetime_iso Modification Date
Example: 2024-08-03T12:00:00+08:00
Origin no no Int64 Source
Example: 1
Type no no Int64 Type
Example: 6
JsonPath no no String JsonPath
Example: JsonPath

ApprovalPaperAttr

Attributes of Approval Form

Referenced by the following interfaces: GetApprovedSet, QueryApplicationForm, QueryCurrApprovalDetail, QueryCurrApprovalDoc, QueryCustomerApprovalDetail, QueryPendingApprovalDoc

name required NULL allowed type description
Action yes no String Corresponding Cloud API Interface
Example: CreateFlow
ActionDescription yes no String Approval Service Description Information
Example: Description
ActionID yes no Int64 Approval Service ID
Example: 1
ActionName yes no String Name of Approval Service
Example: Name
Applicant yes no String Applicant
Example: Lucy
ApplicantUin yes no String Applicant UIN
Example: 130000000281
CTime yes no String Application time
Example: 2024-08-03T12:00:00+08:00
CallbackStatus yes no Int64 Callback status after the approval Is approved. 0: Not Started, 100: Callback Succeeded, 101: Callback Failed
Example: 100
CurrStageNum yes no Int64 Current Approval Node
Example: 1
FlowDescription no no String Associated Approval Workflow Description Information
Example: Description
FlowID yes no Int64 Approval Workflow ID
Example: 1
ModuleName yes no String Name of Cloud API Module Corresponding to Approval Service
Example: approval
OwnerAccount no no String Root account name
Example: Tom
OwnerUin yes no String Primary Account UIN
Example: 130000000281
PaperID yes no Int64 Approval Form ID
Example: 1
ParentID no no Int64 Parent Approval Form ID
Example: 1
ProductName yes no String Cloud Product Name
Example: Name
Reason no no String Approval Reasons
Example: Reason
Schema no no String schema
Example: Schema
RequestBody no yes String Request Parameters, unable to comply with Cloud API 3 Specification here
Example: RequestBody
Seals no yes SealParam Approved Information
Example:View
Status no no Int64 Approval form status. 0: Approval Form Initialized, 1: Approval in Progress, 11: Application Canceled, 12: Approval Rejected, 14: Approval Approved, 15: Automatically Approved
Example: 1
Stages no yes Array of StageParam Corresponding Approval Node Information
Example:View
CallBackResult no no String CallBackResult
Example: CallBackResult
FinalStatus no no Uint64 Final Approval Form Status
Example: 14
RelatedPapers no no Array of ApprovalPaperAttr Associated Approval Form Information
Example:View
Category no no Uint64 Approval Form Type. 1: Triggered by Page, 2: Merged Application Form
Example: Category
LastRemindTime no yes String Last Reminder Time for Approver
Example: 2024-08-03T12:00:00+08:00
AllowSms no no Bool Whether to allow approval via SMS.
Example: false

StageParam

Stage parameters.

Referenced by the following interfaces: CreateCustomerFlow, GetApprovedSet, GetFlowDetail, ModifyApprovalFlow, QueryApplicationForm, QueryCurrApprovalDetail, QueryCurrApprovalDoc, QueryCustomerApprovalDetail, QueryPendingApprovalDoc

name required NULL allowed type description
StageID no no Uint64 stage id
Example: 1
Name yes no String Node name.
Example: Name
SingleSeal yes no Bool false: signs by all approvers. true: signs by one approver.
Example: true
Approvers yes yes Array of String List of approver UINs in the tenant console.
Example: [130000000281]
SerialNumber yes no Uint64 Serial number of the node.
Example: 1
Seals no yes Array of SealParam Seals
Example:View
StageStatus no no Int64 StageStatus
Example: 14
ApproverInfo no yes Array of ApproverInfoParam ApproverInfo
Example:View

FilterAttr

Filter Parameters

Referenced by the following interfaces: DescribeFlowSet, QueryActionSet

name required NULL allowed type description
Name yes no String Parameter Name
Example: Name
Operator yes no String Operators, Supporting equal and like
Example: in
Value yes no String Parameter Value
Example: dcdb

FlowDetail

Approval process details.

Referenced by the following interfaces: GetFlowDetail

name required NULL allowed type description
FlowID no no Int64 Approval process ID.
Example: 18
Platform no no String Platform
Example: tcloud
Name no no String Approval flow name
Example: Name
Description no no String Description of the approval flow.
Example: Description
SchemaProps no no String SchemaProps
Example: SchemaProps
Activated no no Bool Enable/Disable
Example: true
OwnerUin no no String Owner UIN
Example: 130000000013
CreateUin no no String Creator UIN.
Example: 130000000013
CTime no no Datetime_iso Creation date
Example: 2025-04-25T17:12:03+08:00
UpTime no no Datetime_iso Modification Date
Example: 2025-04-25T17:12:03+08:00
Version no no Int64 Version.
Example: 12
CreateUser no no String Create User
Example: Lucy
ActionIDs no yes Array of Int64 Approval business ID.
Example: [1,2,3]
AllowSms no yes Bool Whether to allow approval via SMS.
Example: false
AutoReject no yes Bool Whether to automatically reject.
Example: false
Remark no yes String Remarks
Example: Remark
Stages no yes Array of StageParam Approval node list.
Example:View
Scopes no yes Array of Scope Approval scope list.
Example:View

ActionRelatedInfo

Information about approval flow associated with approval business

Referenced by the following interfaces: QueryCustomerActionScope

name required NULL allowed type description
Users no no Array of UserScope Associated user information (-1: All tenants)
Example:View
Flow no no Array of FlowBaseAttr Associated approval flow information
Example:View
ActionID no no Int64 Approval Service ID
Example: 1

IsOpenAttr

Whether to enable approval workflow.

Referenced by the following interfaces: QueryApprovalFlowStatus

name required NULL allowed type description
IsOpen yes no Bool Whether there is an active approval workflow. True: Yes, False: No
Example: false

QueryActionParma

Queries actions.

Referenced by the following interfaces: QueryActionSet

name required NULL allowed type description
ActionIDs no no Array of Uint64 ID list.
Example: [1,2,3]
Action no no String Action name.
Example: CreateFlow
Module no no String Associated module.
Example: Module
Limit yes no Uint64 Number of the page to return.
Example: 1
Offset yes no Uint64 Offset.
Example: 10
ActionName no no String Business name.
Example: Name
ModuleName no no String The name of the module corresponding to the API.
Example: approval
YunProductName no no String The name of the product corresponding to the API.
Example: BMPPro
Sort no no Order Sort field.
Example:View
Filters no no Array of FilterAttr Filter Condition List
Example:View

ApiInfo

Cloud API. The V3 port is used. Trituple settings must be configured.

Referenced by the following interfaces: QueryApprovalFlowStatus, QueryCustomerApprovalDoc

name required NULL allowed type description
Action yes no String API name.
Example: CreateFlow
Module yes no String Component Name
Example: Module
Version yes no String Version.
Example: 2024-01-01

Order

Information about field used to sort data.

Referenced by the following interfaces: DescribeFlowSet, GetApprovedSet, QueryActionSet, QueryApplicationForm, QueryCurrApprovalDoc, QueryCustomerApprovalDoc, QueryPendingApprovalDoc

name required NULL allowed type description
Field yes no String Name of a field used to sort data.
Example: ActionName
IsDesc yes no Bool Specifies whether to sort data in descending order. true: ascending order. false: descending order.
Example: true

ApproverInfoParam

ApproverInfoParam

Referenced by the following interfaces: CreateCustomerFlow, GetApprovedSet, GetFlowDetail, ModifyApprovalFlow, QueryApplicationForm, QueryCurrApprovalDetail, QueryCurrApprovalDoc, QueryCustomerApprovalDetail, QueryPendingApprovalDoc

name required NULL allowed type description
ApproverUin no no String ApproverUin
Example: 130000000281
ApproverUserName no no String ApproverUserName
Example: Lucy
ApproverStatus no no String ApproverStatus
Example: 14

FlowsData

Approval Flow List

Referenced by the following interfaces: DescribeFlowSet

name required NULL allowed type description
Flows no no Array of FlowBaseAttr Approval Flow List
Example:View
Total no no Int64 Total number
Example: 100

Scope

Validity user scope.

Referenced by the following interfaces: CreateCustomerFlow, GetFlowDetail, ModifyApprovalFlow

name required NULL allowed type description
ActionID yes no Uint64 ID of the API operation performed on the service.
Example: 1
Users yes no Array of UserScope List of the users by which the operation is performed.
Example:View

QueryActionsOutput

QueryActionsOutput

Referenced by the following interfaces: QueryActionSet

name required NULL allowed type description
Total no no Int64 Total number
Example: 100
Actions no yes Array of ActionAttr Approval business list.
Example:View

UserScope

Validity user scope.

Referenced by the following interfaces: CreateCustomerFlow, GetFlowDetail, ModifyApprovalFlow, QueryCustomerActionScope

name required NULL allowed type description
Uin no no String --1: all tenants are covered. Other values: UINs of specific tenants.
Example: 130000000281
IsSubAccount no no Bool Specifies whether the account is a sub-account.
Example: true
UserName no no String Username
Example: Lucy

ApprovalPaperSet

Approval Form List Information

Referenced by the following interfaces: GetApprovedSet, QueryApplicationForm, QueryCurrApprovalDoc, QueryPendingApprovalDoc

name required NULL allowed type description
PaperSet yes yes Array of ApprovalPaperAttr Approval Form List
Example:View
Total yes no Int64 Total number
Example: 100