# adminApi Module ## Overview This module provides APIs for admin operations. ## API Functions ### app-entity-share.ts Source: `src/api/admin/app-entity-share.ts` #### `getAppEntityShares()` ```typescript async function getAppEntityShares(appId: string): Promise ``` #### `createAppEntityShare()` ```typescript async function createAppEntityShare(appId: string, data: AppCreateEntityShareReqVO): Promise<{ success: boolean }> ``` #### `deleteAppEntityShare()` ```typescript async function deleteAppEntityShare(appId: string, data: AppDeleteEntityShareReqVO): Promise<{ success: boolean }> ``` ### app.ts Source: `src/api/admin/app.ts` #### `renameApp()` ```typescript async function renameApp(id: string, data: AppRenameReqVO): Promise ``` #### `createAppByTenants()` ```typescript async function createAppByTenants(data: AppCreateByTenantsReqVO): Promise ``` #### `createEntity()` ```typescript async function createEntity(id: string, data: AppCreateEntityReqVO): Promise ``` #### `deleteApp()` ```typescript async function deleteApp(id: string): Promise ``` #### `deleteWidgets()` ```typescript async function deleteWidgets(appId: string, widgetsId: string): Promise ``` #### `getAppSchema()` ```typescript async function getAppSchema(id: string | number, refresh: boolean = false): Promise ``` #### `getEntities()` ```typescript async function getEntities(id: string): Promise ``` #### `getPredefinedPermissions()` ```typescript async function getPredefinedPermissions(): Promise ``` #### `getSiteMaps()` ```typescript async function getSiteMaps(id: string): Promise ``` #### `getWidgets()` ```typescript async function getWidgets(appId: string, widgetsId: string): Promise ``` #### `newWidgets()` ```typescript async function newWidgets(appId: string, data: AppNewWidgetsReqVO): Promise ``` #### `previewWidgetsData()` ```typescript async function previewWidgetsData(appId: string, data: AppPreviewWidgetsDataReqVO): Promise ``` #### `saveSiteMaps()` ```typescript async function saveSiteMaps(id: string, data: AppSaveSiteMapsReqVO): Promise ``` #### `updateApp()` ```typescript async function updateApp(id: string, data: AppUpdateAppReqVO): Promise ``` #### `updateI18n()` ```typescript async function updateI18n(appId: string, data: AppUpdateI18nReqVO): Promise ``` #### `updateWidgets()` ```typescript async function updateWidgets(appId: string, widgetsId: string, data: AppUpdateWidgetsReqVO): Promise ``` #### `updateWidgetsIngressOptions()` ```typescript async function updateWidgetsIngressOptions(appId: string, widgetsId: string, data: AppUpdateWidgetsIngressOptionsReqVO): Promise ``` #### `widgetsList()` ```typescript async function widgetsList(appId: string): Promise ``` ### automate-rule.ts Source: `src/api/admin/automate-rule.ts` #### `createAutomateRule()` ```typescript async function createAutomateRule(appId: string, entityId: string, data: AutomateRuleCreateReqVO): Promise ``` #### `updateAutomateRule()` ```typescript async function updateAutomateRule(appId: string, entityId: string, ruleId: string, data: AutomateRuleUpdateReqVO): Promise ``` #### `deleteAutomateRule()` ```typescript async function deleteAutomateRule(appId: string, entityId: string, ruleId: string): Promise<{ success: boolean }> ``` #### `listAutomateRules()` ```typescript async function listAutomateRules(appId: string, entityId: string): Promise ``` #### `getAutomateRule()` ```typescript async function getAutomateRule(appId: string, entityId: string, ruleId: string): Promise ``` ### business-hooks.ts Source: `src/api/admin/business-hooks.ts` #### `getAvailableHooklets()` ```typescript async function getAvailableHooklets(): Promise ``` #### `getAppConnections()` ```typescript async function getAppConnections(appId: string): Promise ``` ### config.ts Source: `src/api/admin/config.ts` #### `getAWSConfig()` ```typescript async function getAWSConfig(): Promise ``` ### dashboard.ts Source: `src/api/admin/dashboard.ts` #### `createDashboard()` ```typescript async function createDashboard(appId: string, data: DashboardCreateReqVO): Promise ``` #### `getDashboardOptions()` ```typescript async function getDashboardOptions(appId: string, dashboardId: string): Promise ``` #### `getDashboardList()` ```typescript async function getDashboardList(appId: string): Promise ``` #### `updateDashboardLayout()` ```typescript async function updateDashboardLayout(appId: string, dashboardId: string, data: DashboardUpdateLayoutReqVO): Promise ``` #### `updateDashboardOptions()` ```typescript async function updateDashboardOptions(appId: string, dashboardId: string, data: DashboardUpdateOptionsReqVO): Promise ``` #### `updateDashboardTitle()` ```typescript async function updateDashboardTitle(appId: string, dashboardId: string, data: DashboardUpdateTitleReqVO): Promise ``` #### `deleteDashboard()` ```typescript async function deleteDashboard(appId: string, dashboardId: string): Promise ``` #### `cloneDashboard()` ```typescript async function cloneDashboard(appId: string, dashboardId: string, data: { name: string }): Promise ``` ### dataset.ts Source: `src/api/admin/dataset.ts` #### `createNewDataset()` ```typescript async function createNewDataset(endpoint: string, data: DatasetCreateDatasetReqVO): Promise ``` #### `createNewNode()` ```typescript async function createNewNode(endpoint: string, datasetId: string, parentId: string, data: DatasetCreateNodeReqVO): Promise ``` #### `deleteSingleNode()` ```typescript async function deleteSingleNode(endpoint: string, datasetId: string, nodeId: string): Promise ``` #### `deleteSingleDataset()` ```typescript async function deleteSingleDataset(endpoint: string, datasetId: string): Promise ``` #### `exportSingleDataset()` ```typescript async function exportSingleDataset(endpoint: string, datasetId: string): Promise ``` #### `getChildNode()` ```typescript async function getChildNode(endpoint: string, datasetId: string, parentId: string): Promise ``` #### `getSingleNode()` ```typescript async function getSingleNode(endpoint: string, datasetId: string, nodeId: string): Promise ``` #### `importNewDataset()` ```typescript async function importNewDataset(endpoint: string, data: DatasetImportReqVO): Promise ``` #### `importDatasetWithState()` ```typescript async function importDatasetWithState(endpoint: string, data: DatasetImportReqVO & { _import_action?: string; task_id?: string; config?: any }): Promise ``` #### `listAllDatasets()` ```typescript async function listAllDatasets(endpoint: string): Promise ``` #### `moveSingleNode()` ```typescript async function moveSingleNode(endpoint: string, datasetId: string, nodeId: string, data: DatasetMoveReqVO): Promise ``` #### `updateSingleNode()` ```typescript async function updateSingleNode(endpoint: string, datasetId: string, nodeId: string, data: DatasetUpdateReqVO): Promise ``` ### departments.ts Source: `src/api/admin/departments.ts` #### `adminAddDepartment()` ```typescript async function adminAddDepartment(data: DepartmentsAddReqVO): Promise ``` #### `adminAddActor()` ```typescript async function adminAddActor(data: DepartmentsAddActorReqVO): Promise ``` #### `adminCreateServiceAccount()` ```typescript async function adminCreateServiceAccount(data: DepartmentsCreateServiceAccountReqVO): Promise ``` #### `adminDeleteDepartment()` ```typescript async function adminDeleteDepartment(id: string): Promise ``` #### `adminDeleteActor()` ```typescript async function adminDeleteActor(data: DepartmentsDeleteActorReqVO): Promise ``` #### `adminDeleteUser()` ```typescript async function adminDeleteUser(tenantUserId: string): Promise ``` #### `adminChangeEmployeeAccountPassword()` ```typescript async function adminChangeEmployeeAccountPassword(data: DepartmentsEmployeeAccountChangePasswordReqVO): Promise ``` #### `adminCreateEmployeeAccount()` ```typescript async function adminCreateEmployeeAccount(data: DepartmentsEmployeeAccountCreateReqVO): Promise ``` #### `adminGetActors()` ```typescript async function adminGetActors(): Promise ``` #### `adminGetDepartmentPolicy()` ```typescript async function adminGetDepartmentPolicy(id: string): Promise ``` #### `adminGetDepartmentList()` ```typescript async function adminGetDepartmentList(ids?: number[]): Promise ``` #### `getOrganizationTree()` ```typescript async function getOrganizationTree(parentId: number = 0): Promise ``` #### `adminGetOrganizationUsers()` ```typescript async function adminGetOrganizationUsers(data: DepartmentsGetOrganizationUsersReqVO): Promise ``` #### `adminGetStaffUser()` ```typescript async function adminGetStaffUser(tenantUserId: string): Promise ``` #### `adminGetInviteCodeHistory()` ```typescript async function adminGetInviteCodeHistory(data: DepartmentsInviteCodeHistoryReqVO): Promise ``` #### `adminSwitchInviteCode()` ```typescript async function adminSwitchInviteCode(data: DepartmentsInviteCodeSwitchReqVO): Promise ``` #### `adminInviteUserOneByOne()` ```typescript async function adminInviteUserOneByOne(data: DepartmentsInviteOneByOneReqVO): Promise ``` #### `adminMakeInviteLink()` ```typescript async function adminMakeInviteLink(data: DepartmentsMakeLinkReqVO): Promise ``` #### `adminRelocateDepartment()` ```typescript async function adminRelocateDepartment(id: string, data: DepartmentsRelocateReqVO): Promise ``` #### `adminRenameDepartment()` ```typescript async function adminRenameDepartment(id: string, data: DepartmentsRenameReqVO): Promise ``` #### `adminResendInvite()` ```typescript async function adminResendInvite(data: DepartmentsResendInviteReqVO): Promise ``` #### `adminRenewServiceAccountToken()` ```typescript async function adminRenewServiceAccountToken(data: DepartmentsServiceAccountRenewTokenReqVO): Promise ``` #### `adminSetDepartmentPolicy()` ```typescript async function adminSetDepartmentPolicy(id: string, data: DepartmentsSetDeptPolicyReqVO): Promise ``` #### `adminUpdateStaffUser()` ```typescript async function adminUpdateStaffUser(tenantUserId: string, data: DepartmentsUpdateUserReqVO): Promise ``` ### developer.ts Source: `src/api/admin/developer.ts` #### `queryDeveloperClients()` ```typescript async function queryDeveloperClients(): Promise ``` #### `createDeveloperClient()` ```typescript async function createDeveloperClient(data: DeveloperClientCreateReqVO): Promise ``` #### `getDeveloperClient()` ```typescript async function getDeveloperClient(hashId: string): Promise ``` #### `updateDeveloperClient()` ```typescript async function updateDeveloperClient(hashId: string, data: DeveloperClientUpdateReqVO): Promise ``` #### `deleteDeveloperClient()` ```typescript async function deleteDeveloperClient(hashId: string): Promise ``` #### `createDeveloperClientSecret()` ```typescript async function createDeveloperClientSecret(hashId: string): Promise ``` #### `listDeveloperClientSecrets()` ```typescript async function listDeveloperClientSecrets(hashId: string): Promise ``` #### `revokeDeveloperClientSecret()` ```typescript async function revokeDeveloperClientSecret(hashId: string, secretId: number): Promise ``` #### `queryClientHooklets()` ```typescript async function queryClientHooklets(clientHashId: string): Promise ``` #### `createClientHooklet()` ```typescript async function createClientHooklet(clientHashId: string, data: DeveloperHookletCreateReqVO): Promise ``` #### `getClientHooklet()` ```typescript async function getClientHooklet(clientHashId: string, hookletHashId: string): Promise ``` #### `updateClientHooklet()` ```typescript async function updateClientHooklet(clientHashId: string, hookletHashId: string, data: DeveloperHookletUpdateReqVO): Promise ``` #### `deleteClientHooklet()` ```typescript async function deleteClientHooklet(clientHashId: string, hookletHashId: string): Promise ``` ### entity-tags.ts Source: `src/api/admin/entity-tags.ts` #### `getEntityTagNames()` ```typescript async function getEntityTagNames(appId: number, entityId: number): Promise ``` #### `batchAddEntityTags()` ```typescript async function batchAddEntityTags(appId: number, entityId: number, data: { policy_id: string selection: any tag_names: string[] }): Promise ``` #### `batchRemoveEntityTags()` ```typescript async function batchRemoveEntityTags(appId: number, entityId: number, data: { policy_id: string selection: any tag_names: string[] }): Promise ``` #### `getSelectionTags()` ```typescript async function getSelectionTags(appId: number, entityId: number, data: { policy_id: string selection: any }): Promise ``` #### `updateRecordTags()` ```typescript async function updateRecordTags(appId: number, entityId: number, rowId: number, data: { policy_id: string tags: string[] }): Promise ``` ### entity.ts Source: `src/api/admin/entity.ts` #### `adminInvokeDebugHook()` ```typescript async function adminInvokeDebugHook(appId: string, entityId: string, data: EntityDebugInvokeHookReqVO): Promise ``` #### `adminDeleteEntity()` ```typescript async function adminDeleteEntity(appId: string, entityId: string): Promise ``` #### `adminGetEntityRecycle()` ```typescript async function adminGetEntityRecycle(appId: string): Promise ``` #### `adminGetFieldRecycle()` ```typescript async function adminGetFieldRecycle(appId: string, entityId: string): Promise ``` #### `adminGetEntityInfo()` ```typescript async function adminGetEntityInfo(appId: string, entityId: string): Promise ``` #### `adminSaveEntity()` ```typescript async function adminSaveEntity(appId: string, entityId: string, data: EntitySaveReqVO): Promise ``` #### `adminSaveEntityCustomKeys()` ```typescript async function adminSaveEntityCustomKeys(appId: string, entityId: string, data: EntitySaveCustomKeysReqVO): Promise ``` #### `adminSaveEntityName()` ```typescript async function adminSaveEntityName(appId: string, entityId: string, data: EntitySaveNameReqVO): Promise ``` #### `adminSetSerialInitValue()` ```typescript async function adminSetSerialInitValue(appId: string, entityId: string, data: EntitySerialInitValReqVO): Promise ``` #### `adminUpdateEntityButtons()` ```typescript async function adminUpdateEntityButtons(appId: string, entityId: string, data: EntityUpdateButtonsReqVO): Promise ``` #### `adminUpdateEntityOptions()` ```typescript async function adminUpdateEntityOptions(appId: string, entityId: string, data: EntityUpdateOptionsReqVO): Promise ``` #### `adminUpdateEntitySuccessScreen()` ```typescript async function adminUpdateEntitySuccessScreen(appId: string, entityId: string, data: EntityUpdateSuccessScreenReqVO): Promise ``` #### `adminUpdateEntityNotifications()` ```typescript async function adminUpdateEntityNotifications(appId: string, entityId: string, data: EntityUpdateNotificationsReqVO): Promise ``` #### `adminTestEntityNotification()` ```typescript async function adminTestEntityNotification(appId: string, entityId: string, data: EntityTestNotificationReqVO): Promise ``` #### `adminGetEntityDataRecycle()` ```typescript async function adminGetEntityDataRecycle(appId: string, entityId: string): Promise ``` #### `sendEntityClone()` ```typescript async function sendEntityClone(appId: string, entityId: string, data: EntityCloneReqVO): Promise ``` ### extension.ts Source: `src/api/admin/extension.ts` #### `getExtensionHttpRequest()` ```typescript async function getExtensionHttpRequest(id: string, path: string): Promise ``` #### `getExtensionStaticFile()` ```typescript async function getExtensionStaticFile(id: string, filepath: string): Promise ``` ### ingress.ts Source: `src/api/admin/ingress.ts` #### `createEntityIngress()` ```typescript async function createEntityIngress(appId: string, entityId: string, data: AppIngressCreateReqVO): Promise ``` #### `createEntityIngressFrom()` ```typescript async function createEntityIngressFrom(appId: string, entityId: string, fromIngressId: string, data: AppIngressCreateReqVO): Promise ``` #### `deleteEntityIngress()` ```typescript async function deleteEntityIngress(appId: string, entityId: string, id: string): Promise ``` #### `getEntityIngress()` ```typescript async function getEntityIngress(appId: string, entityId: string, id: string): Promise ``` #### `getEntityIngressBlocks()` ```typescript async function getEntityIngressBlocks(appId: string, entityId: string, id: string): Promise ``` #### `getEntityIngressByHashID()` ```typescript async function getEntityIngressByHashID(appId: string, entityId: string, id: string): Promise ``` #### `getEntityIngressList()` ```typescript async function getEntityIngressList(appId: string, entityId: string): Promise ``` #### `updateEntityIngress()` ```typescript async function updateEntityIngress(appId: string, entityId: string, id: string, data: AppIngressUpdateReqVO): Promise ``` #### `updateEntityIngressBlocks()` ```typescript async function updateEntityIngressBlocks(appId: string, entityId: string, id: string, data: AppIngressUpdateBlocksReqVO): Promise ``` #### `updateEntityIngressByHashID()` ```typescript async function updateEntityIngressByHashID(appId: string, entityId: string, id: string, data: AppIngressUpdateReqVO): Promise ``` ### integration.ts Source: `src/api/admin/integration.ts` #### `getIntegrationTemplateCategories()` ```typescript async function getIntegrationTemplateCategories(): Promise ``` #### `getIntegrationChalaxyProxy()` ```typescript async function getIntegrationChalaxyProxy(path: string): Promise ``` #### `getIntegrationAllTemplates()` ```typescript async function getIntegrationAllTemplates(): Promise ``` #### `getIntegrationTemplate()` ```typescript async function getIntegrationTemplate(id: string): Promise ``` #### `getIntegrationConnectors()` ```typescript async function getIntegrationConnectors(params?: { key?: string }): Promise ``` #### `sendIntegrationConnectorStartAuth()` ```typescript async function sendIntegrationConnectorStartAuth(id: string, data?: any): Promise ``` #### `sendIntegrationConnectorInvokeTrigger()` ```typescript async function sendIntegrationConnectorInvokeTrigger(id: string, triggerKey: string, data?: any): Promise ``` ### kiosk-flow.ts Source: `src/api/admin/kiosk-flow.ts` #### `cloneKioskFlow()` ```typescript async function cloneKioskFlow(appId: string, entityId: string, id: string, data: any): Promise ``` #### `createKioskFlow()` ```typescript async function createKioskFlow(appId: string, entityId: string, data: EntityKioskFlowCreateReqVO): Promise ``` #### `deleteKioskFlow()` ```typescript async function deleteKioskFlow(appId: string, entityId: string, id: string): Promise ``` #### `getKioskFlow()` ```typescript async function getKioskFlow(appId: string, entityId: string, id: string): Promise ``` #### `getKioskFlowList()` ```typescript async function getKioskFlowList(appId: string, entityId: string): Promise ``` #### `updateKioskFlow()` ```typescript async function updateKioskFlow(appId: string, entityId: string, id: string, data: EntityKioskFlowUpdateReqVO): Promise ``` ### print-template-background.ts Source: `src/api/admin/print-template-background.ts` #### `uploadPrintTemplateBackground()` ```typescript async function uploadPrintTemplateBackground(appId: string, entityId: string, templateId: string, data: PrintTemplateBackgroundUploadReqVO): Promise ``` #### `deletePrintTemplateBackground()` ```typescript async function deletePrintTemplateBackground(appId: string, entityId: string, templateId: string): Promise ``` ### print-templates.ts Source: `src/api/admin/print-templates.ts` #### `createEntityPrintTemplate()` ```typescript async function createEntityPrintTemplate(appId: string, entityId: string, data: EntityPrintTemplatesCreateReqVO): Promise ``` #### `deleteEntityPrintTemplate()` ```typescript async function deleteEntityPrintTemplate(appId: string, entityId: string, id: string): Promise ``` #### `getEntityPrintTemplate()` ```typescript async function getEntityPrintTemplate(appId: string, entityId: string, id: string): Promise ``` #### `getEntityPrintTemplateList()` ```typescript async function getEntityPrintTemplateList(appId: string, entityId: string): Promise ``` #### `updateEntityPrintTemplate()` ```typescript async function updateEntityPrintTemplate(appId: string, entityId: string, id: string, data: EntityPrintTemplatesUpdateReqVO): Promise ``` ### tenant.ts Source: `src/api/admin/tenant.ts` #### `getTenantConfig()` ```typescript async function getTenantConfig(data: TenantConfigGetReqVO): Promise ``` #### `updateTenantConfig()` ```typescript async function updateTenantConfig(data: TenantConfigUpdateReqVO): Promise ``` #### `updateTenantConfigAuth()` ```typescript async function updateTenantConfigAuth(data: TenantConfigUpdateAuthReqVO): Promise ``` #### `updateTenantConfigAuthBgImage()` ```typescript async function updateTenantConfigAuthBgImage(data: TenantConfigUpdateAuthBgImageReqVO): Promise ``` #### `updateTenantConfigEmail()` ```typescript async function updateTenantConfigEmail(data: TenantConfigUpdateEmailReqVO): Promise ``` #### `updateTenantConfigIcon()` ```typescript async function updateTenantConfigIcon(data: TenantConfigUpdateIconReqVO): Promise ``` #### `updateTenantConfigLogo()` ```typescript async function updateTenantConfigLogo(data: TenantConfigUpdateLogoReqVO): Promise ``` #### `updateTenantConfigMeta()` ```typescript async function updateTenantConfigMeta(data: TenantConfigUpdateMetaReqVO): Promise ``` #### `updateTenantConfigName()` ```typescript async function updateTenantConfigName(data: TenantConfigUpdateNameReqVO): Promise ``` #### `createTenantCustomDomain()` ```typescript async function createTenantCustomDomain(data: TenantCreateCustomDomainReqVO): Promise ``` #### `getTenant()` ```typescript async function getTenant(): Promise ``` #### `getTenantApiService()` ```typescript async function getTenantApiService(apiServiceId: string): Promise ``` #### `getTenantApiServiceList()` ```typescript async function getTenantApiServiceList(): Promise ``` #### `getTenantCustomDomain()` ```typescript async function getTenantCustomDomain(): Promise ``` #### `getTenantKioskFlowListAll()` ```typescript async function getTenantKioskFlowListAll(): Promise ``` #### `createTenantKioskGroup()` ```typescript async function createTenantKioskGroup(data: TenantKioskGroupCreateReqVO): Promise ``` #### `deleteTenantKioskGroup()` ```typescript async function deleteTenantKioskGroup(id: string): Promise ``` #### `getTenantKioskGroup()` ```typescript async function getTenantKioskGroup(id: string): Promise ``` #### `queryTenantKioskGroup()` ```typescript async function queryTenantKioskGroup(data: TenantKioskGroupQueryReqVO): Promise ``` #### `updateTenantKioskGroup()` ```typescript async function updateTenantKioskGroup(id: string, data: TenantKioskGroupUpdateReqVO): Promise ``` #### `getTenantSubscriptions()` ```typescript async function getTenantSubscriptions(path?: string): Promise ``` #### `getTenantSystemMap()` ```typescript async function getTenantSystemMap(): Promise ``` #### `verifyTenantCustomDomainOwner()` ```typescript async function verifyTenantCustomDomainOwner(data: TenantVerifyCustomDomainOwnerReqVO): Promise ``` #### `getTenantUsageSnapshot()` ```typescript async function getTenantUsageSnapshot(): Promise ``` #### `getTenantUsageDaily()` ```typescript async function getTenantUsageDaily(days?: number): Promise ``` ### workflow.ts Source: `src/api/admin/workflow.ts` #### `deployEntityWorkflow()` ```typescript async function deployEntityWorkflow(appId: string, entityId: string, data: EntityWorkflowDeployReqVO): Promise ``` #### `getEntityWorkflow()` ```typescript async function getEntityWorkflow(appId: string, entityId: string, workingId?: string): Promise ``` #### `createEntityWorkflowVersion()` ```typescript async function createEntityWorkflowVersion(appId: string, entityId: string): Promise ``` #### `updateEntityWorkflow()` ```typescript async function updateEntityWorkflow(appId: string, entityId: string, data: EntityWorkflowUpdateReqVO): Promise ```