Class WorkflowsApi

Hierarchy

WorkflowsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WorkflowsApi(basePath?: string): WorkflowsApi

- Defined in api/api.ts:104163
Parameters
- Optional basePath: string
Returns WorkflowsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemWorkflowsCountGet

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

- Defined in api/api.ts:104176
Get Workflows Count

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

systemWorkflowsGet

systemWorkflowsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Workflow>>

- Defined in api/api.ts:104217
Get Workflows

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

systemWorkflowsIdCopyPost

systemWorkflowsIdCopyPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Workflow>

- Defined in api/api.ts:104273
Copy Workflow

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

systemWorkflowsIdDelete

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

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

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

systemWorkflowsIdGet

systemWorkflowsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Workflow>

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

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

systemWorkflowsIdPatch

systemWorkflowsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Workflow>

- Defined in api/api.ts:104385
Update Workflow

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

systemWorkflowsIdPut

systemWorkflowsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Workflow>

- Defined in api/api.ts:104430
Replace Workflow

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

systemWorkflowsPost

systemWorkflowsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Workflow>

- Defined in api/api.ts:104474
Create Workflow

Parameters
- params: object
  - workflow: Workflow
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Workflow>

Generated using TypeDoc