Class DepartmentsApi

Hierarchy

DepartmentsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DepartmentsApi(basePath?: string): DepartmentsApi

- Defined in api/api.ts:42978
Parameters
- Optional basePath: string
Returns DepartmentsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemDepartmentsCountGet

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

- Defined in api/api.ts:42991
Get Department Count

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

systemDepartmentsGet

systemDepartmentsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Department>>

- Defined in api/api.ts:43032
Get Department

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

systemDepartmentsIdDelete

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

- Defined in api/api.ts:43088
Delete Department By Id

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

systemDepartmentsIdGet

systemDepartmentsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Department>

- Defined in api/api.ts:43125
Get Department By Id

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

systemDepartmentsIdPatch

systemDepartmentsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Department>

- Defined in api/api.ts:43163
Update Department

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

systemDepartmentsIdPut

systemDepartmentsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Department>

- Defined in api/api.ts:43208
Replace Department

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

systemDepartmentsPost

systemDepartmentsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Department>

- Defined in api/api.ts:43252
Create Department

Parameters
- params: object
  - department: Department
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Department>

Generated using TypeDoc