Class DashboardApi

DashboardApi - object-oriented interface

Export

DashboardApi

Hierarchy

BaseAPI
- DashboardApi

Index

Constructors

Properties

axios basePath configuration

Methods

getConfigurationPages getDashboardConfigurationPage

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getConfigurationPages

getConfigurationPages(requestParameters?, options?): Promise<AxiosResponse<ConfigurationPageInfo[], any>>
Parameters
- requestParameters: DashboardApiGetConfigurationPagesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConfigurationPageInfo[], any>>
Summary
Gets the configuration pages.

Throws
Memberof
DashboardApi
- Defined in generated-client/api/dashboard-api.ts:218

getDashboardConfigurationPage

getDashboardConfigurationPage(requestParameters?, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: DashboardApiGetDashboardConfigurationPageRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a dashboard configuration page.

Throws
Memberof
DashboardApi
- Defined in generated-client/api/dashboard-api.ts:230