Class ProjectNotesApi

Hierarchy

ProjectNotesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ProjectNotesApi(basePath?: string): ProjectNotesApi

- Defined in api/api.ts:71305
Parameters
- Optional basePath: string
Returns ProjectNotesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

projectProjectsIdNotesCountGet

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

- Defined in api/api.ts:71319
Get Project Notes Count

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

projectProjectsIdNotesGet

projectProjectsIdNotesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ProjectNote>>

- Defined in api/api.ts:71366
Get Project Notes

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

projectProjectsIdNotesNoteIdDelete

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

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

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

projectProjectsIdNotesNoteIdGet

projectProjectsIdNotesNoteIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProjectNote>

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

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

projectProjectsIdNotesNoteIdPatch

projectProjectsIdNotesNoteIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProjectNote>

- Defined in api/api.ts:71515
Update Project Note

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

projectProjectsIdNotesNoteIdPut

projectProjectsIdNotesNoteIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProjectNote>

- Defined in api/api.ts:71566
Replace Project Note

Parameters
- params: object
  - id: number
  - note: ProjectNote
  - noteId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProjectNote>

projectProjectsIdNotesPost

projectProjectsIdNotesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProjectNote>

- Defined in api/api.ts:71616
Create Project Note

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

Generated using TypeDoc