Class ScheduleEntriesApi

Hierarchy

ScheduleEntriesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ScheduleEntriesApi(basePath?: string): ScheduleEntriesApi

- Defined in api/api.ts:83025
Parameters
- Optional basePath: string
Returns ScheduleEntriesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

scheduleEntriesCountGet

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

- Defined in api/api.ts:83038
Get Schedules Count

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

scheduleEntriesGet

scheduleEntriesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ScheduleEntry>>

- Defined in api/api.ts:83079
Get Schedules

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

scheduleEntriesIdDelete

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

- Defined in api/api.ts:83135
Delete Schedule By Id

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

scheduleEntriesIdGet

scheduleEntriesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ScheduleEntry>

- Defined in api/api.ts:83172
Get Schedule By Id

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

scheduleEntriesIdPatch

scheduleEntriesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ScheduleEntry>

- Defined in api/api.ts:83210
Update Schedule

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

scheduleEntriesIdPut

scheduleEntriesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ScheduleEntry>

- Defined in api/api.ts:83255
Replace Schedule

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

scheduleEntriesPost

scheduleEntriesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ScheduleEntry>

- Defined in api/api.ts:83299
Create Schedule

Parameters
- params: object
  - scheduleEntry: ScheduleEntry
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ScheduleEntry>

Generated using TypeDoc