Class WorkflowEventsApi

Hierarchy

WorkflowEventsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WorkflowEventsApi(basePath?: string): WorkflowEventsApi

- Defined in api/api.ts:100742
Parameters
- Optional basePath: string
Returns WorkflowEventsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemWorkflowsIdEventsCountGet

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

- Defined in api/api.ts:100756
Get Workflow Events Count

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

systemWorkflowsIdEventsEventIdDelete

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

- Defined in api/api.ts:100798
Delete Workflow Event By Id

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

systemWorkflowsIdEventsEventIdGet

systemWorkflowsIdEventsEventIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkflowEvent>

- Defined in api/api.ts:100841
Get Workflow Event By Id

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

systemWorkflowsIdEventsEventIdPatch

systemWorkflowsIdEventsEventIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkflowEvent>

- Defined in api/api.ts:100885
Update Workflow Event

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

systemWorkflowsIdEventsEventIdPut

systemWorkflowsIdEventsEventIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkflowEvent>

- Defined in api/api.ts:100936
Replace Workflow Event

Parameters
- params: object
  - eventId: number
  - id: number
  - workflowEvent: WorkflowEvent
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkflowEvent>

systemWorkflowsIdEventsEventIdTestGet

systemWorkflowsIdEventsEventIdTestGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<JArray>

- Defined in api/api.ts:100986
Test Workflow Evemt

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

systemWorkflowsIdEventsGet

systemWorkflowsIdEventsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<WorkflowEvent>>

- Defined in api/api.ts:101034
Get Workflow Events

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

systemWorkflowsIdEventsPost

systemWorkflowsIdEventsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkflowEvent>

- Defined in api/api.ts:101096
Create Workflow Event

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

Generated using TypeDoc