Class TicketsApi

Hierarchy

TicketsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TicketsApi(basePath?: string): TicketsApi

- Defined in api/api.ts:93132
Parameters
- Optional basePath: string
Returns TicketsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceTicketsCountGet

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

- Defined in api/api.ts:93146
Get Tickets Count

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

serviceTicketsGet

serviceTicketsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Ticket>>

- Defined in api/api.ts:93191
Get Tickets

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

serviceTicketsIdActivitiesCountGet

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

- Defined in api/api.ts:93247
Gets count of activities associated to the ticket /// Please use the /sales/activities/count?conditions=ticket/id={id} endpoint

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

serviceTicketsIdActivitiesGet

serviceTicketsIdActivitiesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ActivityReference>>

- Defined in api/api.ts:93286
Gets activities associated to the ticket /// Please use the /sales/activities?conditions=ticket/id={id} endpoint

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ActivityReference>>

serviceTicketsIdConfigurationsConfigIdDelete

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

- Defined in api/api.ts:93332
Delete Configuration Association

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

serviceTicketsIdConfigurationsConfigIdGet

serviceTicketsIdConfigurationsConfigIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ConfigurationReference>

- Defined in api/api.ts:93375
Get Configuration Association

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

serviceTicketsIdConfigurationsCountGet

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

- Defined in api/api.ts:93417
Get Ticket Configurations Count

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

serviceTicketsIdConfigurationsGet

serviceTicketsIdConfigurationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ConfigurationReference>>

- Defined in api/api.ts:93456
Get Ticket Configurations

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ConfigurationReference>>

serviceTicketsIdConfigurationsPost

serviceTicketsIdConfigurationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ConfigurationReference>

- Defined in api/api.ts:93502
Create Configuration Association

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

serviceTicketsIdDelete

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

- Defined in api/api.ts:93546
Delete Ticket By Id

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

serviceTicketsIdDocumentsCountGet

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

- Defined in api/api.ts:93583
Get Ticket Documents Count

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

serviceTicketsIdDocumentsGet

serviceTicketsIdDocumentsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<DocumentReference>>

- Defined in api/api.ts:93622
Gets the documents associated to the ticket /// Please use the /system/documents?recordType=Ticket&recordId={id} endpoint

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<DocumentReference>>

serviceTicketsIdGet

serviceTicketsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Ticket>

- Defined in api/api.ts:93667
Get Ticket By Id

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

serviceTicketsIdMergePost

serviceTicketsIdMergePost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<SuccessResponse>

- Defined in api/api.ts:93705
Merge Company

Parameters
- params: object
  - id: number
  - merge: TicketMerge
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<SuccessResponse>

serviceTicketsIdPatch

serviceTicketsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Ticket>

- Defined in api/api.ts:93750
Update Ticket

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

serviceTicketsIdProductsCountGet

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

- Defined in api/api.ts:93794
Gets the products associated to the ticket /// Please use the /procurement/products/count?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint

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

serviceTicketsIdProductsGet

serviceTicketsIdProductsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ProductReference>>

- Defined in api/api.ts:93833
Gets the products associated to the ticket /// Please use the /procurement/products?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ProductReference>>

serviceTicketsIdPut

serviceTicketsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Ticket>

- Defined in api/api.ts:93879
Replace Ticket

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

serviceTicketsIdScheduleentriesCountGet

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

- Defined in api/api.ts:93923
Gets the schedule entries count associated to the ticket /// Please use the /schedule/entries/count?conditions=type/id=4 AND objectId={id} endpoint

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

serviceTicketsIdScheduleentriesGet

serviceTicketsIdScheduleentriesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ScheduleEntryReference>>

- Defined in api/api.ts:93962
Gets the schedule entries associated to the ticket /// Please use the /schedule/entries?conditions=type/id=4 AND objectId={id} endpoint

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<ScheduleEntryReference>>

serviceTicketsIdTimeentriesCountGet

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

- Defined in api/api.ts:94007
Gets time entries count associated to the ticket /// Please use the /time/entries/count?conditions=(chargeToType="ServiceTicket" OR chargeToType="ProjectTicket") AND chargeToId={id} endpoint

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

serviceTicketsIdTimeentriesGet

serviceTicketsIdTimeentriesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<TimeEntryReference>>

- Defined in api/api.ts:94046
Gets time entries associated to the ticket /// Please use the /time/entries?conditions=(chargeToType="ServiceTicket" OR chargeToType="ProjectTicket") AND chargeToId={id} endpoint

Parameters
- params: object
  - id: number
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<TimeEntryReference>>

serviceTicketsPost

serviceTicketsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Ticket>

- Defined in api/api.ts:94091
Create Ticket

Parameters
- params: object
  - ticket: Ticket
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Ticket>

serviceTicketsSearchPost

serviceTicketsSearchPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Ticket>>

- Defined in api/api.ts:94132
Ticket Search

Parameters
- params: object
  - filterValues: FilterValues
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<Ticket>>

Generated using TypeDoc