Class CustomReportsApi

Hierarchy

CustomReportsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CustomReportsApi(basePath?: string): CustomReportsApi

- Defined in api/api.ts:41991
Parameters
- Optional basePath: string
Returns CustomReportsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemCustomReportsCountGet

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

- Defined in api/api.ts:42004
Get Custom Report Count

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

systemCustomReportsGet

systemCustomReportsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<CustomReport>>

- Defined in api/api.ts:42045
Get Custom Report

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

systemCustomReportsIdDelete

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

- Defined in api/api.ts:42101
Delete Custom Report By Id

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

systemCustomReportsIdGet

systemCustomReportsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CustomReport>

- Defined in api/api.ts:42138
Get Custom Report By Id

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

systemCustomReportsIdPatch

systemCustomReportsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CustomReport>

- Defined in api/api.ts:42176
Update Custom Report

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

systemCustomReportsIdPut

systemCustomReportsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CustomReport>

- Defined in api/api.ts:42221
Replace Custom Report

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

systemCustomReportsPost

systemCustomReportsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<CustomReport>

- Defined in api/api.ts:42265
Create Custom Report

Parameters
- params: object
  - customReport: CustomReport
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<CustomReport>

Generated using TypeDoc