Class ProjectsApi

Hierarchy

ProjectsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ProjectsApi(basePath?: string): ProjectsApi

- Defined in api/api.ts:75096
Parameters
- Optional basePath: string
Returns ProjectsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

projectProjectsCountGet

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

- Defined in api/api.ts:75110
Get Projects Count

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

projectProjectsGet

projectProjectsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Project>>

- Defined in api/api.ts:75155
Get Projects

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

projectProjectsIdDelete

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

- Defined in api/api.ts:75211
Delete Project By Id

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

projectProjectsIdGet

projectProjectsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Project>

- Defined in api/api.ts:75248
Get Project By Id

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

projectProjectsIdPatch

projectProjectsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Project>

- Defined in api/api.ts:75286
Update Project

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

projectProjectsIdPut

projectProjectsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Project>

- Defined in api/api.ts:75331
Replace Project

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

projectProjectsPost

projectProjectsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Project>

- Defined in api/api.ts:75375
Create Project

Parameters
- params: object
  - project: Project
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Project>

Generated using TypeDoc