Namespace BiExcellence.OpenBi.Api.SystemInfo
Classes
- ConfigurationSetting
A single server configuration setting, part of ServerSettings.
- LicenseComponent
A single licensed component (e.g. a named user pool), part of LicenseInformation.
- LicenseComponentStatus
Whether one component is licensed, from
GET /system/licenseinformation/components/{name}.
- LicenseInformation
The server's current license status, from
GET /system/licenseinformation.
- OpenBiApiClientSystemExtensions
Extension methods for the
/systemREST API.
- ServerSettings
The server's raw configuration, from
GET /system/configuration. Only reachable on the dedicated configuration port, in addition to the normal permission check.
- SharedConfigurationSetting
A server setting kept in the database and used by every server connected to it, from
GET system/sharedconfiguration. A server's ownConfiguration.xml, environment variables and command line still override it. Only reachable on the dedicated configuration port.
- SharedConfigurationSettingRequest
The body of
POST system/sharedconfiguration/{name}.
- SystemErrorLog
A logged unhandled exception, from
GET /system/errors.
- SystemHealth
The result of every health check, from
GET /system/health.
- SystemHealthCheck
The result of one health check, part of SystemHealth.
- SystemMailRequest
A request to send an e-mail via the server's configured SMTP settings.
Interfaces
- IConfigurationSetting
A single server configuration setting, part of ServerSettings.
- ILicenseComponent
A single licensed component (e.g. a named user pool), part of LicenseInformation.
- ILicenseComponentStatus
Whether one component is licensed, from
GET /system/licenseinformation/components/{name}.
- ILicenseInformation
The server's current license status, from
GET /system/licenseinformation.
- IServerSettings
The server's raw configuration, from
GET /system/configuration. Only reachable on the dedicated configuration port, in addition to the normal permission check.
- ISharedConfigurationSetting
A server setting kept in the database and used by every server connected to it, from
GET system/sharedconfiguration. A server's ownConfiguration.xml, environment variables and command line still override it. Only reachable on the dedicated configuration port.
- ISystemErrorLog
A logged unhandled exception, from
GET /system/errors.
- ISystemHealth
The result of every health check, from
GET /system/health.
- ISystemHealthCheck
The result of one health check, part of SystemHealth.
- ISystemMailRequest
A request to send an e-mail via the server's configured SMTP settings.
Enums
- SystemHealthStatus
The status of one health check, or of all of them together.