Home Docs OpenAPI

Home Docs OpenAPI

Model APIs
- copyById
- copyByIdAndFetch
- copyByIds
- copyByIdsAndFetch
- count
- createList
- createListAndFetch
- createOne
- createOneAndFetch
- deleteById
- deleteByIds
- deleteBySliceId
- getById
- getByIds
- getCopyableFields
- getDefaultValues
- getRowFiles
- getUnmaskedField
- getUnmaskedFields
- searchList
- searchName
- searchPage
- searchPivot
- searchSimpleAgg
- updateByFilter
- updateList
- updateListAndFetch
- updateOne
- updateOneAndFetch
- uploadFile
- uploadFileToRow
Toolkit
- fixUnencryptedData
- recompute
- validateExpression
ChangeLog
- getChangeLog
- getSliceChangeLog
- searchPage_1
- searchPageByModel
File Record
- getByFileId
Import Template
- getTemplateFile
- listByModel
SysPreData
- loadPreSystemData
- loadPreTenantData
- loadSystemDataByUpload
SysView
- getModelViews
- setDefaultView
Data Export
- dynamicExport
- exportByFileTemplate
- exportByTemplate
Import
- importWithoutTemplate
- importByTemplate
Metadata Upgrade API
Export Template
- listByModel
DeptInfo
- readCustomize
AiRobot
- Chat API
- Persist Chat Message
- Stream Chat
DocumentTemplate
- generateDocument
FlowConfig
- getByModel
- getFlowById
SysCron
- Execute multiple for once now
- Execute once now
SysModel
- getMetaModel
SysOptionSet
- getOptionItems
- getOptionSetItems
Flow Automation
- API Event
- Onchange Event
- Simulate Event Message
DesignAppEnv
- getNotVersionedChanges
- mergeBetweenEnv
- previewBetweenEnv
DesignAppVersion
- createOne_1
- publish
- reloadAppVersion
DesignModel
- downloadCode
- downloadZip
- previewCode
- previewDDL
File
- getByFileId
- getRowFiles
- uploadFileToField
- uploadFileToRow
UserAccount Controller
- changeMyPassword
- getMyAccount
- logout
- saveMyAccount
- Lock User Account
- Unlock User Account
UserProfile Controller
- Get Current User Profile
- Get Current User Info
- Update or Create Current User Profile
Login
- forgotPassword
- loginByApple
- loginByEmail
- loginByMobileCode
- loginByOAuth2
- loginByPassword
- registerByPassword
- resetPassword
- sendEmailCode
- sendMobileCode
Metadata API
- reload
- getMetaModel
- upgrade
Schemas
- Schemas
  - AI Chat Message
  - SimpleAggQuery
  - AggQuery
  - FlowEventVO
  - ModelViewVO
  - DesignAppVersionVO
  - FileInfo
  - SimpleQueryParams
  - SubQueries
  - Trigger Event Body Params
- API Response Body
- AI Stream Request
- AI User Message
- AggFunctions
- Filters
- AppleLoginDTO
- ImportWizard
- BulkUpdateParams
- DesignAppVersionDTO
- ChangePasswordDTO
- MetadataUpgradePackage
- FlowEventDTO
- EmailCodeDTO
- CountParams
- EmailPasswordDTO
- Orders
- SubQuery
- ModelViewDTO
- ForgotPasswordDTO
- ExportParams
- Simple ModelFields
- QueryParams
- JsonNode
- Simple ModelField
- GetByIdParams
- MobileCodeDTO
- GetByIdsParams
- Name
- SseEmitter
- OAuthCredential
- SearchListParams
- ResetPasswordDTO
- SearchNameParams
- SimpleAggParams
- Trigger Event Params
- User
- UserAccountDTO
- UserProfileDTO

AggFunctions

Support multiple aggregation queries:

[]

["SUM", "amount"]

[["SUM", "amount"], ["COUNT", "id"]]

[
    "SUM",
    "amount"
]