Class FilterCyclesApi

FilterCyclesApi - object-oriented interface

export

Hierarchy

BaseAPI
- FilterCyclesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FilterCyclesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): FilterCyclesApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value axios: AxiosInstance = globalAxios
Returns FilterCyclesApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

createFilterCycle

createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<AxiosResponse<FilterCycle>>

- Defined in api.ts:2178
summary

Create a filter cycle

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- filterCycle: FilterCycle
- Optional options: any
Returns Promise<AxiosResponse<FilterCycle>>

deleteFilterCycle

deleteFilterCycle(id: string, options?: any): Promise<AxiosResponse<FilterCycle>>

- Defined in api.ts:2190
summary

Delete a filter cycle

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<FilterCycle>>

disableAllInCycle

disableAllInCycle(id: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:2202
summary

Disable all report tasks in a cycle

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<void>>

enableAllInCycle

enableAllInCycle(id: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:2214
summary

Enable all report tasks in a cycle

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<void>>

getFilterCycle

getFilterCycle(id: string, options?: any): Promise<AxiosResponse<FilterCycle>>

- Defined in api.ts:2226
summary

Get a filter cycle

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<FilterCycle>>

getFilterCycles

getFilterCycles(templateId: string, options?: any): Promise<AxiosResponse<FilterCycle[]>>

- Defined in api.ts:2238
summary

List filter cycles

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- templateId: string
- Optional options: any
Returns Promise<AxiosResponse<FilterCycle[]>>

updateFilterCycle

updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<AxiosResponse<FilterCycle>>

- Defined in api.ts:2251
summary

Update a filter cycle

throws

{RequiredError}

memberof

FilterCyclesApi

Parameters
- id: string
- filterCycle: FilterCycle
- Optional options: any
Returns Promise<AxiosResponse<FilterCycle>>

Generated using TypeDoc