Class PortalConfigurationsApi

Hierarchy

PortalConfigurationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PortalConfigurationsApi(basePath?: string): PortalConfigurationsApi

- Defined in api/api.ts:67123
Parameters
- Optional basePath: string
Returns PortalConfigurationsApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

systemPortalConfigurationsCountGet

systemPortalConfigurationsCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:67136
Get Portal Configurations Count

Parameters
- params: object
  - Optional conditions?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

systemPortalConfigurationsGet

systemPortalConfigurationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<PortalConfiguration>>

- Defined in api/api.ts:67177
Get Portal Configurations

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<PortalConfiguration>>

systemPortalConfigurationsIdDelete

systemPortalConfigurationsIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:67233
Delete Portal Configuration By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

systemPortalConfigurationsIdGet

systemPortalConfigurationsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalConfiguration>

- Defined in api/api.ts:67270
Get Portal Configuration By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<PortalConfiguration>

systemPortalConfigurationsIdPatch

systemPortalConfigurationsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalConfiguration>

- Defined in api/api.ts:67308
Update Portal Configuration

Parameters
- params: object
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<PortalConfiguration>

systemPortalConfigurationsIdPortalImageGet

systemPortalConfigurationsIdPortalImageGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:67353
Get Portal Image

Parameters
- params: object
  - id: number
  - Optional lastUpdated?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

systemPortalConfigurationsIdPut

systemPortalConfigurationsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalConfiguration>

- Defined in api/api.ts:67395
Replace Portal Configuration

Parameters
- params: object
  - id: number
  - portalConfiguration: PortalConfiguration
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<PortalConfiguration>

systemPortalConfigurationsIdReportImageGet

systemPortalConfigurationsIdReportImageGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:67440
Get Report Image

Parameters
- params: object
  - id: number
  - Optional lastUpdated?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

systemPortalConfigurationsPost

systemPortalConfigurationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalConfiguration>

- Defined in api/api.ts:67481
Create Portal Configuration

Parameters
- params: object
  - portalConfiguration: PortalConfiguration
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<PortalConfiguration>

Generated using TypeDoc