- V2
-
V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
-
SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
SystemConfig
SystemConfig
[GET] /api/v1/sysconfig
Get the system configuration record.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig
Update the system configuration.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/name
Update the company name.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/icon
Update the favicon of the system.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/icon
Get system icon.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/logo
Update the logo displayed in login page.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/bgimage
Update the background image displayed in login page.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/passwordPolicy
Get password policy.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/passwordPolicy
Update password policy.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/lockedTime
Get locked time.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/lockedTime
Update locked time.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/global-organization
Get the global tenant setting.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/global-organization
Update the global tenant setting.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/css
Update locked time.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/html
Update locked time.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/email-settings
Update email settings.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/security-settings
Get security related settings, include 'PasswordPolicy', 'LockedTime' and 'AllowUserResetPassword'.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/security-settings
Update security related settings, include 'PasswordPolicy', 'LockedTime' and 'AllowUserResetPassword'.
Request Schema
Response
Status Code: 200
Success
Models
Ƭ SystemConfigBizModel
| Name | Type | Description | Example |
|---|---|---|---|
| companyNameNullable | string | The system title. | "Wyn Enterprise" |
| sysIconNullable | string | The base64 string of the system icon. | "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..." |
| logoNullable | string | The base64 string of the logo in login page. | "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..." |
| bgImageNullable | string | The base64 string of the background image in login page. | "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..." |
| passwordPolicy | PasswordPolicy | ||
| lockedTimeNullable | int32 | The locked time for multiple invalid login, in minutes. | 60 |
| loginPageTipNullable | string | The tip information in the login page. | "This is just a tip." |
| cssNullable | string | The custom CSS content. | "body { font-family: sans-serif; }" |
| htmlNullable | string | The custom HTML content. | "Custom HTML Content" |
| allowUserResetPasswordNullable | Boolean | Whether allow user to reset password. | true |
| showGlobalTenantNullable | Boolean | Whether show the "Global" organization when logging in. | true |
| defaultCookieLifetimeNullable | int32 | The cookie expiration time for the users who didn't check the "remember me" option when logging in, in days. | |
| cookieLifetimeForRememberLoginNullable | int32 | The cookie expiration time for the users who checked the "remember me" option when logging in, in days. | 14 |
Ƭ PasswordPolicy
Enum:
WeakPasswordPolicyNormalPasswordPolicyStrongPasswordPolicy
The password policy.
Ƭ SysConfigDataModel
| Name | Type | Description | Example |
|---|---|---|---|
| dataNullable | string |
Ƭ GlobalTenantUpdateModel
| Name | Type | Description | Example |
|---|---|---|---|
| showGlobalTenant | Boolean |
Ƭ EmailSettingSMTPSettings
| Name | Type | Description | Example |
|---|---|---|---|
| serverAddressNullable | string | The SMTP server address. | "smtp.gmail.com" |
| serverPort | int32 | The listening port of the SMTP service. | 465 |
| enableSSL | Boolean | Whether enable SSL protocol. | true |
| userNameNullable | string | The user name for logging in the SMTP service. | "example@gmail.com" |
| passwordNullable | string | The password of the user. | "MyPassword" |
| senderNameNullable | string | The display name of the email sender. | "MyDisplayName" |
| senderEmailNullable | string | The display email address of the email sender. | "example@gmail.com" |
| emailSenderType | EmailSenderType | ||
| googleClientIdNullable | string | The client id for of the Google mail service. | "your_client_id" |
| googleClientSecretNullable | string | The client secret of the Google mail service. | "your_client_secret" |
| googleTokensNullable | string | The generated token for sending email using Google mail service. | "generated_token" |
Ƭ EmailSenderType
Enum:
SMTPGoogleAPI
The email sender type.
Ƭ SystemConfigSecuritySettings
| Name | Type | Description | Example |
|---|---|---|---|
| passwordPolicy | PasswordPolicy | ||
| lockedTime | int32 | The locked time, in minutes. | 60 |
| allowUserResetPassword | Boolean | Whether allow user to reset password. | |
| defaultCookieLifetimeNullable | int32 | The cookie expiration time for the users who didn't check the "remember me" option when logging in, in days. | |
| cookieLifetimeForRememberLoginNullable | int32 | The cookie expiration time for the users who checked the "remember me" option when logging in, in days. | 14 |