Class WorkRolesApi

Hierarchy

WorkRolesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WorkRolesApi(basePath?: string): WorkRolesApi

- Defined in api/api.ts:101485
Parameters
- Optional basePath: string
Returns WorkRolesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

timeWorkRolesCountGet

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

- Defined in api/api.ts:101498
Get Work Role Count

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

timeWorkRolesGet

timeWorkRolesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<WorkRole>>

- Defined in api/api.ts:101539
Get Work Role

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

timeWorkRolesIdDelete

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

- Defined in api/api.ts:101595
Delete Work Role By Id

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

timeWorkRolesIdGet

timeWorkRolesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkRole>

- Defined in api/api.ts:101632
Get Work Role By Id

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

timeWorkRolesIdPatch

timeWorkRolesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkRole>

- Defined in api/api.ts:101670
Update Work Role

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

timeWorkRolesIdPut

timeWorkRolesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkRole>

- Defined in api/api.ts:101715
Replace Work Role

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

timeWorkRolesPost

timeWorkRolesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkRole>

- Defined in api/api.ts:101759
Create Work Role

Parameters
- params: object
  - workRole: WorkRole
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkRole>

Generated using TypeDoc