Class PortalSecuritiesApi

Hierarchy

PortalSecuritiesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PortalSecuritiesApi(basePath?: string): PortalSecuritiesApi

- Defined in api/api.ts:67837
Parameters
- Optional basePath: string
Returns PortalSecuritiesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemPortalSecuritiesCountGet

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

- Defined in api/api.ts:67850
Get Portal Securities Count

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

systemPortalSecuritiesGet

systemPortalSecuritiesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<PortalSecurity>>

- Defined in api/api.ts:67891
Get Portal Securities

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<PortalSecurity>>

systemPortalSecuritiesIdGet

systemPortalSecuritiesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalSecurity>

- Defined in api/api.ts:67947
Get Portal Security By Id

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

systemPortalSecuritiesIdPatch

systemPortalSecuritiesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalSecurity>

- Defined in api/api.ts:67985
Update Portal Security

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

systemPortalSecuritiesIdPut

systemPortalSecuritiesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PortalSecurity>

- Defined in api/api.ts:68030
Replace Portal Security

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

Generated using TypeDoc