Class SystemApi

SystemApi - object-oriented interface

Hierarchy

BaseAPI
- SystemApi

Constructors

constructor

new SystemApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): SystemApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SystemApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:38

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getConfiguration

getConfiguration(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ServerConfiguration, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerConfiguration, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1375

getDefaultMetadataOptions

getDefaultMetadataOptions(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MetadataOptions, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MetadataOptions, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1385

getEndpointInfo

getEndpointInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EndPointInfo, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EndPointInfo, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1395

getLogEntries

getLogEntries(
requestParameters?: SystemApiGetLogEntriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ActivityLogEntryQueryResult, any, {}>>
Parameters
- requestParameters: SystemApiGetLogEntriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ActivityLogEntryQueryResult, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1406

getLogFile

getLogFile(
requestParameters: SystemApiGetLogFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SystemApiGetLogFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1417

getNamedConfiguration

getNamedConfiguration(
requestParameters: SystemApiGetNamedConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: SystemApiGetNamedConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1428

getPingSystem

getPingSystem(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1438

getPublicSystemInfo

getPublicSystemInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PublicSystemInfo, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PublicSystemInfo, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1448

getServerLogs

getServerLogs(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LogFile[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LogFile[], any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1458

getSystemInfo

getSystemInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SystemInfo, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SystemInfo, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1468

getSystemStorage

getSystemStorage(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SystemStorageDto, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SystemStorageDto, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1478

getUtcTime

getUtcTime(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UtcTimeResponse, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UtcTimeResponse, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1488

logFile

logFile(
requestParameters?: SystemApiLogFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ClientLogDocumentResponseDto, any, {}>>
Parameters
- requestParameters: SystemApiLogFileRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ClientLogDocumentResponseDto, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1499

postPingSystem

postPingSystem(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1509

restartApplication

restartApplication(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1519

shutdownApplication

shutdownApplication(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1529

updateBrandingConfiguration

updateBrandingConfiguration(
requestParameters: SystemApiUpdateBrandingConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SystemApiUpdateBrandingConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1540

updateConfiguration

updateConfiguration(
requestParameters: SystemApiUpdateConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SystemApiUpdateConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1551

updateNamedConfiguration

updateNamedConfiguration(
requestParameters: SystemApiUpdateNamedConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SystemApiUpdateNamedConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/system-api.ts:1562

Class SystemApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SystemApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getConfiguration

Parameters

Returns Promise<AxiosResponse<ServerConfiguration, any, {}>>

Throws

getDefaultMetadataOptions

Parameters

Returns Promise<AxiosResponse<MetadataOptions, any, {}>>

Throws

getEndpointInfo

Parameters

Returns Promise<AxiosResponse<EndPointInfo, any, {}>>

Throws

getLogEntries

Parameters

Returns Promise<AxiosResponse<ActivityLogEntryQueryResult, any, {}>>

Throws

getLogFile

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getNamedConfiguration

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

getPingSystem

Parameters

Returns Promise<AxiosResponse<string, any, {}>>

Throws

getPublicSystemInfo

Parameters

Returns Promise<AxiosResponse<PublicSystemInfo, any, {}>>

Throws

getServerLogs

Parameters

Returns Promise<AxiosResponse<LogFile[], any, {}>>

Throws

getSystemInfo

Parameters

Returns Promise<AxiosResponse<SystemInfo, any, {}>>

Throws

getSystemStorage

Parameters

Returns Promise<AxiosResponse<SystemStorageDto, any, {}>>

Throws

getUtcTime

Parameters

Returns Promise<AxiosResponse<UtcTimeResponse, any, {}>>

Throws

logFile

Parameters

Returns Promise<AxiosResponse<ClientLogDocumentResponseDto, any, {}>>

Throws

postPingSystem

Parameters

Returns Promise<AxiosResponse<string, any, {}>>

Throws

restartApplication

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

shutdownApplication

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

updateBrandingConfiguration

`Protected`axios

`Protected`basePath

`Protected`configuration