Function SystemApiFp

Returns {
    getConfiguration(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ServerConfiguration>,
    >;
    getDefaultMetadataOptions(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MetadataOptions>,
    >;
    getEndpointInfo(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<EndPointInfo>,
    >;
    getLogEntries(
        startIndex?: number,
        limit?: number,
        minDate?: string,
        maxDate?: string,
        hasUserId?: boolean,
        name?: string,
        overview?: string,
        shortOverview?: string,
        type?: string,
        itemId?: string,
        username?: string,
        severity?: LogLevel,
        sortBy?: ActivityLogSortBy[],
        sortOrder?: SortOrder[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ActivityLogEntryQueryResult>,
    >;
    getLogFile(
        name: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getNamedConfiguration(
        key: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getPingSystem(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    getPublicSystemInfo(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PublicSystemInfo>,
    >;
    getServerLogs(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>,
    >;
    getSystemInfo(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>,
    >;
    getSystemStorage(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SystemStorageDto>,
    >;
    getUtcTime(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UtcTimeResponse>,
    >;
    logFile(
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ClientLogDocumentResponseDto>,
    >;
    postPingSystem(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    restartApplication(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    shutdownApplication(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateBrandingConfiguration(
        brandingOptionsDto: BrandingOptionsDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateConfiguration(
        serverConfiguration: ServerConfiguration,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateNamedConfiguration(
        key: string,
        body: any,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• getConfiguration: function

  • getConfiguration(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ServerConfiguration>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ServerConfiguration>,
    >

    Throws

• getDefaultMetadataOptions: function

  • getDefaultMetadataOptions(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MetadataOptions>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MetadataOptions>,
    >

    Throws

• getEndpointInfo: function

  • getEndpointInfo(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>,
    >

    Throws

• getLogEntries: function

  • getLogEntries(
        startIndex?: number,
        limit?: number,
        minDate?: string,
        maxDate?: string,
        hasUserId?: boolean,
        name?: string,
        overview?: string,
        shortOverview?: string,
        type?: string,
        itemId?: string,
        username?: string,
        severity?: LogLevel,
        sortBy?: ActivityLogSortBy[],
        sortOrder?: SortOrder[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ActivityLogEntryQueryResult>,
    >

    Parameters

    • OptionalstartIndex: number

      The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit: number

      The maximum number of records to return.

    • OptionalminDate: string

      The minimum date.

    • OptionalmaxDate: string

      The maximum date.

    • OptionalhasUserId: boolean

      Filter log entries if it has user id, or not.

    • Optionalname: string

      Filter by name.

    • Optionaloverview: string

      Filter by overview.

    • OptionalshortOverview: string

      Filter by short overview.

    • Optionaltype: string

      Filter by type.

    • OptionalitemId: string

      Filter by item id.

    • Optionalusername: string

      Filter by username.

    • Optionalseverity: LogLevel

      Filter by log severity.

    • OptionalsortBy: ActivityLogSortBy[]

      Specify one or more sort orders. Format: SortBy=Name,Type.

    • OptionalsortOrder: SortOrder[]

      Sort Order..

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ActivityLogEntryQueryResult>,
    >

    Throws

• getLogFile: function

  • getLogFile(
        name: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      The name of the log file to get.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Throws

• getNamedConfiguration: function

  • getNamedConfiguration(
        key: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • key: string

      Configuration key.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Throws

• getPingSystem: function

  • getPingSystem(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

    Throws

• getPublicSystemInfo: function

  • getPublicSystemInfo(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PublicSystemInfo>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PublicSystemInfo>,
    >

    Throws

• getServerLogs: function

  • getServerLogs(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>>

    Throws

• getSystemInfo: function

  • getSystemInfo(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>

    Throws

• getSystemStorage: function

  • getSystemStorage(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SystemStorageDto>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SystemStorageDto>,
    >

    Throws

• getUtcTime: function

  • getUtcTime(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UtcTimeResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UtcTimeResponse>,
    >

    Throws

• logFile: function

  • logFile(
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ClientLogDocumentResponseDto>,
    >

    Parameters

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ClientLogDocumentResponseDto>,
    >

    Throws

• postPingSystem: function

  • postPingSystem(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

    Throws

• restartApplication: function

  • restartApplication(
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• shutdownApplication: function

  • shutdownApplication(
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• updateBrandingConfiguration: function

  • updateBrandingConfiguration(
        brandingOptionsDto: BrandingOptionsDto,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • brandingOptionsDto: BrandingOptionsDto

      Branding configuration.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• updateConfiguration: function

  • updateConfiguration(
        serverConfiguration: ServerConfiguration,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • serverConfiguration: ServerConfiguration

      Configuration.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• updateNamedConfiguration: function

  • updateNamedConfiguration(
        key: string,
        body: any,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • key: string

      Configuration key.

    • body: any

      Configuration.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws