# Softa 中文

## API Docs
- Model APIs [copyById](https://api-cn.softa.io/api-412869348.md): 基于 id 复制一条记录，并返回新增记录的 id。
- Model APIs [copyByIdAndFetch](https://api-cn.softa.io/api-412869349.md): 基于 id 复制一条记录，并返回新增记录的数据。
- Model APIs [copyByIds](https://api-cn.softa.io/api-412869350.md): 基于 ids 复制多条数据，并返回新数据的 ids。
- Model APIs [copyByIdsAndFetch](https://api-cn.softa.io/api-412869351.md): 基于 ids 复制多条数据，并返回新增的数据列表。
- Model APIs [count](https://api-cn.softa.io/api-412869352.md): Returns a count or group counting based on the specified `filter`, `groupBy`, and `orders`.
- Model APIs [createList](https://api-cn.softa.io/api-412869353.md): 批量创建并返回创建后的 id 列表。
- Model APIs [createListAndFetch](https://api-cn.softa.io/api-412869354.md): 批量创建数据，并从数据库返回最新数据结果。
- Model APIs [createOne](https://api-cn.softa.io/api-412869355.md): 创建单条数据并返回数据 ID。
- Model APIs [createOneAndFetch](https://api-cn.softa.io/api-412869356.md): 创建单条数据，并从数据库返回最新数据。
- Model APIs [deleteById](https://api-cn.softa.io/api-412869357.md): 根据 id 参数删除1条记录。时间轴模型，则会删除该 id 相关的所有切片记录。
- Model APIs [deleteByIds](https://api-cn.softa.io/api-412869358.md): 根据 ids 参数批量删除数据。
- Model APIs [deleteBySliceId](https://api-cn.softa.io/api-412869359.md): 根据 sliceId 参数删除时间轴模型1条切片记录。
- Model APIs [getById](https://api-cn.softa.io/api-412869360.md): Get one row by ID.
- Model APIs [getByIds](https://api-cn.softa.io/api-412869361.md): Get multiple rows by IDs.
- Model APIs [getCopyableFields](https://api-cn.softa.io/api-412869362.md): 基于 id 复制一条记录，并返回可复制的字段值，但是并不自动插入数据库，而是由客户端调用 Create 方法入库。
- Model APIs [getDefaultValues](https://api-cn.softa.io/api-414960740.md): Get the default values of the model fields.
- Model APIs [getRowFiles](https://api-cn.softa.io/api-412869363.md): Get the fileInfos by modelName and rowId
- Model APIs [getUnmaskedField](https://api-cn.softa.io/api-412869364.md): 获取指定字段的脱敏前数据，适用于原始字段是掩码脱敏字段。
- Model APIs [getUnmaskedFields](https://api-cn.softa.io/api-412869365.md): "获取多个字段的脱敏前数据，适用于原始字段是掩码脱敏字段。
- Model APIs [searchList](https://api-cn.softa.io/api-412869366.md): 根据指定的字段 fields、筛选条件 filters、排序条件 orders、分组计数字段，以及子查询条件，返回数据列表，不进行分页，但可以通过 pageSize 控制返回数据行数，默认返回 50 条数据。
- Model APIs [searchName](https://api-cn.softa.io/api-412869367.md): Query the displayNames based on the match field, filters, orders, limitSize. Default limit to 10.
- Model APIs [searchPage](https://api-cn.softa.io/api-412869368.md): 根据指定的字段 fields、筛选条件 filters、排序条件 orders、页码 pageNumber、分页大小 pageSize、分组计数字段，以及子查询条件，返回分页数据，不传时使用后端默认值。
- Model APIs [searchPivot](https://api-cn.softa.io/api-412869369.md): 根据指定的字段 fields、筛选条件 filters、排序条件 orders、groupBy 字段、splitBy 字段，返回透视表数据。
- Model APIs [searchSimpleAgg](https://api-cn.softa.io/api-412869370.md): 纯粹的 SUM、AVG、MIN、MAX、COUNT 聚合函数查询。如： ["SUM", "amount"]，返回值的 key 为驼峰字符串 sumAmount。
- Model APIs [updateByFilter](https://api-cn.softa.io/api-412869371.md): 根据筛选条件更新数据，当前用户权限范围内，符合筛选条件的数据都会被更新。
- Model APIs [updateList](https://api-cn.softa.io/api-412869372.md): 根据数据列表的 id 字段批量更新数据。成功返回 True，失败则抛出异常。
- Model APIs [updateListAndFetch](https://api-cn.softa.io/api-412869373.md): 根据数据列表的 id 字段批量更新数据，并从数据库返回更新后的数据列表。
- Model APIs [updateOne](https://api-cn.softa.io/api-412869374.md): 根据数据的 id 更新1条记录。成功返回 True，失败则抛出异常。
- Model APIs [updateOneAndFetch](https://api-cn.softa.io/api-412869375.md): 根据数据的 id 字段更新1条数据，并从数据库返回更新后的数据值。
- Model APIs [uploadFile](https://api-cn.softa.io/api-412869376.md): Upload a file to the specified model to bind with a field.
- Model APIs [uploadFileToRow](https://api-cn.softa.io/api-412869377.md): Upload a file to the specified model and row, and return the fileInfo.
- Model APIs [onChange](https://api-cn.softa.io/api-433787010.md): 
- Toolkit [fixUnencryptedData](https://api-cn.softa.io/api-412869378.md): 修复未加密历史数据：
- Toolkit [recompute](https://api-cn.softa.io/api-412869379.md): 重新计算历史数据：
- Toolkit [validateExpression](https://api-cn.softa.io/api-412869380.md): Validates the expression.
- ChangeLog [getChangeLog](https://api-cn.softa.io/api-412869381.md): Read the data change records according to the id, and return the page of the data change record, default in reverse order by change time.
- ChangeLog [getSliceChangeLog](https://api-cn.softa.io/api-412869382.md): Read the timeline slice change log page according to sliceId, default in reverse order by change time.
- ChangeLog [searchPage_1](https://api-cn.softa.io/api-412869383.md): Return paginated data based on the specified filters, sorting conditions, page number, page size.
- ChangeLog [searchPageByModel](https://api-cn.softa.io/api-412869384.md): Return paginated data based on the specified filters, sorting conditions, page number, page size.
- Export Template [listByModel](https://api-cn.softa.io/api-412869385.md): List all export templates of the specified model
- File Record [getByFileId](https://api-cn.softa.io/api-412869386.md): Get the fileInfo by fileId
- Import Template [getTemplateFile](https://api-cn.softa.io/api-412869387.md): Get the fileInfo of the import template by template ID.
- Import Template [listByModel](https://api-cn.softa.io/api-412869388.md): List all import templates of the specified model
- SysPreData [loadPreSystemData](https://api-cn.softa.io/api-421250432.md): Load the specified list of predefined system data files from the root directory resources/data-system,
- SysPreData [loadPreTenantData](https://api-cn.softa.io/api-421250433.md): Load the predefined tenant data from resources/data-tenant for the current tenant.
- SysPreData [loadSystemDataByUpload](https://api-cn.softa.io/api-421250434.md): Upload a predefined data file to load data.
- SysView [getModelViews](https://api-cn.softa.io/api-412869391.md): Get the list of views visible to the current user based on the model name. [Public views, personal views] and sorted by sequence.
- SysView [setDefaultView](https://api-cn.softa.io/api-412869392.md): Set the current user's default view based on the model name and view ID: {"modelName": "Employee", "viewId": 1}
- Data Export [dynamicExport](https://api-cn.softa.io/api-412869393.md): Export data by dynamic fields and QueryParams, without export template.
- Data Export [exportByFileTemplate](https://api-cn.softa.io/api-412869394.md): Exported by file template and QueryParams
- Data Export [exportByTemplate](https://api-cn.softa.io/api-412869395.md): Exported by exportTemplate with dynamic fields and QueryParams
- Import [dynamicImport](https://api-cn.softa.io/api-412869396.md): Import data from the uploaded file
- Import [importByTemplate](https://api-cn.softa.io/api-412869397.md): Import data from the uploaded file
- Import [validateImport](https://api-cn.softa.io/api-433787008.md): Validate import data from the uploaded file without persisting
- DeptInfo [readCustomize](https://api-cn.softa.io/api-412869400.md): Read customized department info by ID.
- DocumentTemplate [generateDocument](https://api-cn.softa.io/api-412869401.md): Generate a word or PDF document according to the specified template ID and row ID.
- SysModel [getMetaModel](https://api-cn.softa.io/api-421250431.md): Get the MetaModel object by modelName
- SysOptionSet [getOptionItems](https://api-cn.softa.io/api-414960739.md): Get the option set items of the specified option set code.
- SysOptionSet [getOptionSetItems](https://api-cn.softa.io/api-412869403.md): Get the option set items of the specified option set code.
- AiRobot [Chat API](https://api-cn.softa.io/api-412869404.md): Non-streaming Chat API
- AiRobot [Persist Chat Message](https://api-cn.softa.io/api-414960738.md): Response: Conversation ID, User Message ID, AI Message ID
- AiRobot [Stream Chat](https://api-cn.softa.io/api-412869405.md): Stream chat by SSE(Server-Sent Events).
- FlowConfig [getByModel](https://api-cn.softa.io/api-412869406.md): Get flow list by model.
- FlowConfig [getFlowById](https://api-cn.softa.io/api-412869407.md): Get flow config by ID.
- SysCron [Execute multiple for once now](https://api-cn.softa.io/api-412869408.md): Immediately run the specified multiple cron jobs for once.
- SysCron [Execute once now](https://api-cn.softa.io/api-412869409.md): Immediately run the specified cron job for once.
- Flow Automation [API Event](https://api-cn.softa.io/api-412869410.md): Trigger the flow by API event. 
- Flow Automation [Onchange Event](https://api-cn.softa.io/api-412869411.md): Pass the current data and return a Map of field value changes that affect other fields.
- Flow Automation [Simulate Event Message](https://api-cn.softa.io/api-412869412.md): Simulate flow triggering by passing a FlowEventMessage, suitable for scenarios such as ChangeLog, Cron, etc.
- DesignAppEnv [getNotVersionedChanges](https://api-cn.softa.io/api-412869413.md): Get the not versioned changes of the App env.
- DesignAppEnv [mergeBetweenEnv](https://api-cn.softa.io/api-412869414.md): Merge changes between environments.
- DesignAppEnv [previewBetweenEnv](https://api-cn.softa.io/api-412869415.md): Preview changes between two environments.
- DesignAppEnv [compareDesignWithRuntime](https://api-cn.softa.io/api-433786997.md): Compare design-time snapshot with runtime metadata for an environment.
- DesignAppVersion [createOne_1](https://api-cn.softa.io/api-412869416.md): Create one row and return the id.
- DesignAppVersion [publish](https://api-cn.softa.io/api-412869417.md): Publish the version to the target environment.
- DesignAppVersion [reloadAppVersion](https://api-cn.softa.io/api-412869418.md): Reload App env changes to current version.
- DesignAppVersion [addWorkItem](https://api-cn.softa.io/api-433786998.md): Add a DONE WorkItem to the version (only allowed in DRAFT status). Merge order is determined by add order.
- DesignAppVersion [freezeVersion](https://api-cn.softa.io/api-433786999.md): Freeze the version, which means the version has been deployed and cannot be edited anymore.
- DesignAppVersion [previewDDL_3](https://api-cn.softa.io/api-433787000.md): Preview DDL SQL generated from version change data, ready for copy to database client.
- DesignAppVersion [previewVersion](https://api-cn.softa.io/api-433787001.md): Preview the merged content of the version without modifying its status.
- DesignAppVersion [removeWorkItem](https://api-cn.softa.io/api-433787002.md): Remove a WorkItem from the version (only allowed in DRAFT status).
- DesignAppVersion [sealVersion](https://api-cn.softa.io/api-433787003.md): Seal the version: aggregate WorkItem changes, generate DDL and diffHash, transition to SEALED.
- DesignAppVersion [unsealVersion](https://api-cn.softa.io/api-433787004.md): Unseal a SEALED version back to DRAFT. Not allowed if deployed.
- DesignModel [downloadCode](https://api-cn.softa.io/api-412869419.md): Download specified code file
- DesignModel [downloadZip](https://api-cn.softa.io/api-412869420.md): Download model code package
- DesignModel [previewCode](https://api-cn.softa.io/api-412869421.md): Preview the generated model code, including Java class code for Entity, Service, ServiceImpl, and Controller
- DesignModel [downloadAllZip](https://api-cn.softa.io/api-433787005.md): Download all model code packages in one zip
- DesignModel [previewDDL_1](https://api-cn.softa.io/api-412869422.md): Preview the DDL SQL of model, including table creation and index creation
- DesignModel [previewAllCode](https://api-cn.softa.io/api-433787006.md): Preview all generated model code packages grouped by language
- RPC [RPC](https://api-cn.softa.io/api-412869423.md): 
- File [getByFileId](https://api-cn.softa.io/api-414960741.md): Get the fileInfo by fileId
- File [getRowFiles](https://api-cn.softa.io/api-414960742.md): Get the fileInfos by modelName and rowId
- File [uploadFileToField](https://api-cn.softa.io/api-414960743.md): Upload a file to the specified model and row, and return the fileInfo.
- File [uploadFileToRow](https://api-cn.softa.io/api-414960744.md): Upload a file to the specified model and row, and return the fileInfo.
- UserAccount Controller [changeMyPassword](https://api-cn.softa.io/api-414969625.md): 
- UserAccount Controller [getMyAccount](https://api-cn.softa.io/api-414969626.md): 
- UserAccount Controller [Lock User Account](https://api-cn.softa.io/api-421380251.md): 
- UserAccount Controller [logout](https://api-cn.softa.io/api-414969627.md): 
- UserAccount Controller [saveMyAccount](https://api-cn.softa.io/api-414969628.md): 
- UserAccount Controller [Unlock User Account](https://api-cn.softa.io/api-421380252.md): 
- UserAccount Controller [Batch Unlock User Accounts](https://api-cn.softa.io/api-433787007.md): 
- UserProfile Controller [Get Current User Profile](https://api-cn.softa.io/api-414969629.md): Retrieves the profile details of the logged-in user.
- UserProfile Controller [Get Current User Info](https://api-cn.softa.io/api-414969630.md): Retrieves the user info of the logged-in user.
- UserProfile Controller [Update or Create Current User Profile](https://api-cn.softa.io/api-414969631.md): 
- Login [forgotPassword](https://api-cn.softa.io/api-414998466.md): 
- Login [loginByApple](https://api-cn.softa.io/api-414998467.md): 
- Login [loginByEmail](https://api-cn.softa.io/api-414998468.md): 
- Login [loginByMobileCode](https://api-cn.softa.io/api-414998469.md): 
- Login [loginByOAuth2](https://api-cn.softa.io/api-414998470.md): 
- Login [loginByPassword](https://api-cn.softa.io/api-414998471.md): 
- Login [registerByPassword](https://api-cn.softa.io/api-414998472.md): 
- Login [resetPassword](https://api-cn.softa.io/api-414998473.md): 
- Login [sendEmailCode](https://api-cn.softa.io/api-414998474.md): 
- Login [sendMobileCode](https://api-cn.softa.io/api-414998475.md): 
- Metadata API [getMetaModel](https://api-cn.softa.io/api-421380253.md): Get the MetaModel object by modelName
- Metadata API [reload](https://api-cn.softa.io/api-412869398.md): 
- Metadata API [upgrade](https://api-cn.softa.io/api-412869399.md): 
- Metadata API [exportRuntimeMetadata](https://api-cn.softa.io/api-433787009.md): Export all runtime metadata rows for a version-controlled model
- DesignApp [transitionStatus_1](https://api-cn.softa.io/api-433787011.md): Transition the App status with business validation.
- DesignDeployment [deployToEnv](https://api-cn.softa.io/api-433787012.md): Deploy a sealed/frozen Version to an Env. Automatically merges released versions by sealedTime, generates DDL, and executes the deployment.
- DesignDeployment [previewDDL_2](https://api-cn.softa.io/api-433787013.md): Preview DDL SQL of a deployment (table + index), ready for copy to database client.
- DesignDeployment [previewDeployment](https://api-cn.softa.io/api-433787014.md): Preview the deployment content.
- DesignDeployment [retry](https://api-cn.softa.io/api-433787015.md): Retry a failed deployment by creating a new Deployment with the same parameters.
- DesignPortfolio [transitionStatus](https://api-cn.softa.io/api-433787016.md): Transition the Portfolio status with business validation.
- DesignWorkItem [cancelWorkItem](https://api-cn.softa.io/api-433787017.md): Cancel the WorkItem (from IN_PROGRESS, READY, or DEFERRED).
- DesignWorkItem [deferWorkItem](https://api-cn.softa.io/api-433787018.md): Defer the WorkItem (from IN_PROGRESS).
- DesignWorkItem [doneWorkItem](https://api-cn.softa.io/api-433787019.md): Complete the WorkItem, setting closedTime and transitioning status to DONE.
- DesignWorkItem [mergeToLatestVersion](https://api-cn.softa.io/api-433787020.md): Merge a DONE WorkItem into the latest DRAFT version. Auto-creates a DRAFT version if none exists.
- DesignWorkItem [previewChanges](https://api-cn.softa.io/api-433787021.md): Preview all metadata changes accumulated under this WorkItem.
- DesignWorkItem [previewDDL](https://api-cn.softa.io/api-433787022.md): Preview DDL SQL generated from WorkItem metadata changes, ready for copy to database client.
- DesignWorkItem [readyWorkItem](https://api-cn.softa.io/api-433787023.md): Mark the WorkItem as READY (from IN_PROGRESS).
- DesignWorkItem [reopenWorkItem](https://api-cn.softa.io/api-433787024.md): Reopen a DONE, CANCELLED, or DEFERRED WorkItem back to IN_PROGRESS.
- Export History [myExportHistory](https://api-cn.softa.io/api-433787025.md): List current user's export history of the specified model
- Import History [myImportHistory](https://api-cn.softa.io/api-433787026.md): List current user's import history of the specified model
- SigningDocument [Sign a signing document](https://api-cn.softa.io/api-433787027.md): 

## Schemas
- Schemas [AI Chat Message](https://api-cn.softa.io/schema-243457365.md): 
- Schemas [FlowEventVO](https://api-cn.softa.io/schema-243457374.md): 
- Schemas [ModelViewVO](https://api-cn.softa.io/schema-243457376.md): 
- Schemas [DesignAppVersionVO](https://api-cn.softa.io/schema-243457377.md): 
- Schemas [SimpleQueryParams](https://api-cn.softa.io/schema-243457380.md): 
- Schemas [FileInfo](https://api-cn.softa.io/schema-243457381.md): 
- Schemas [SubQueries](https://api-cn.softa.io/schema-243457383.md): 
- Schemas [UserInfo](https://api-cn.softa.io/schema-243457391.md): 
- Schemas [UserPermission](https://api-cn.softa.io/schema-243457392.md): 
- [AI Stream Request](https://api-cn.softa.io/schema-244946372.md): 
- [API Response Body](https://api-cn.softa.io/schema-243457366.md): 
- [AI User Message](https://api-cn.softa.io/schema-244946373.md): 
- [Filters](https://api-cn.softa.io/schema-243457367.md): 
- [AggFunctions](https://api-cn.softa.io/schema-243457368.md): 
- [ImportWizard](https://api-cn.softa.io/schema-243457369.md): 
- [AppleLoginDTO](https://api-cn.softa.io/schema-244952365.md): 
- [ExportParams](https://api-cn.softa.io/schema-243457370.md): 
- [BulkUpdateParams](https://api-cn.softa.io/schema-243457371.md): 
- [DesignAppVersionDTO](https://api-cn.softa.io/schema-244946374.md): 
- [ChangePasswordDTO](https://api-cn.softa.io/schema-244952366.md): 
- [QueryParams](https://api-cn.softa.io/schema-243457372.md): 
- [MetadataUpgradePackage](https://api-cn.softa.io/schema-243457373.md): 
- [FlowEventDTO](https://api-cn.softa.io/schema-244946375.md): 
- [EmailCodeDTO](https://api-cn.softa.io/schema-244952367.md): 
- [CountParams](https://api-cn.softa.io/schema-243457375.md): 
- [EmailPasswordDTO](https://api-cn.softa.io/schema-244952368.md): 
- [Orders](https://api-cn.softa.io/schema-243457378.md): 
- [SubQuery](https://api-cn.softa.io/schema-243457379.md): 
- [ModelViewDTO](https://api-cn.softa.io/schema-244946376.md): 
- [ForgotPasswordDTO](https://api-cn.softa.io/schema-244952369.md): 
- [ImportFieldDTO](https://api-cn.softa.io/schema-257808262.md): 
- [Simple ModelFields](https://api-cn.softa.io/schema-243457382.md): 
- [JsonNode](https://api-cn.softa.io/schema-244952370.md): 
- [Simple ModelField](https://api-cn.softa.io/schema-243457384.md): 
- [GetByIdParams](https://api-cn.softa.io/schema-243457385.md): 
- [MobileCodeDTO](https://api-cn.softa.io/schema-244952371.md): 
- [GetByIdsParams](https://api-cn.softa.io/schema-243457386.md): 
- [SearchListParams](https://api-cn.softa.io/schema-243457387.md): 
- [Name](https://api-cn.softa.io/schema-244952372.md): 
- [OnChangeParams](https://api-cn.softa.io/schema-257808263.md): 
- [SearchNameParams](https://api-cn.softa.io/schema-243457388.md): 
- [OAuthCredential](https://api-cn.softa.io/schema-244952373.md): 
- [SseEmitter](https://api-cn.softa.io/schema-243457389.md): 
- [Trigger Event Params](https://api-cn.softa.io/schema-243457390.md): 
- [ResetPasswordDTO](https://api-cn.softa.io/schema-244952374.md): 
- [SimpleAggParams](https://api-cn.softa.io/schema-243457393.md): 
- [SignRenderOptionsDto](https://api-cn.softa.io/schema-257808264.md): 
- [SignatureEvidenceDto](https://api-cn.softa.io/schema-257808265.md): 
- [SignaturePlacementDto](https://api-cn.softa.io/schema-257808266.md): 
- [SigningDocumentSignRequest](https://api-cn.softa.io/schema-257808267.md): 
- [User](https://api-cn.softa.io/schema-244952375.md): 
- [UserAccountDTO](https://api-cn.softa.io/schema-244952376.md): 
- [UnlockAccountDTO](https://api-cn.softa.io/schema-257808268.md): 
- [UserProfileDTO](https://api-cn.softa.io/schema-244952377.md): 
- [UnlockAccountsDTO](https://api-cn.softa.io/schema-257808269.md):