Class AgreementTypeWorkRolesApi

Hierarchy

AgreementTypeWorkRolesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgreementTypeWorkRolesApi(basePath?: string): AgreementTypeWorkRolesApi

- Defined in api/api.ts:16042
Parameters
- Optional basePath: string
Returns AgreementTypeWorkRolesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAgreementTypesIdWorkrolesCountGet

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

- Defined in api/api.ts:16056
Get Work Roles Count

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

financeAgreementTypesIdWorkrolesGet

financeAgreementTypesIdWorkrolesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<AgreementTypeWorkRole>>

- Defined in api/api.ts:16103
Get Work Roles

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

financeAgreementTypesIdWorkrolesPost

financeAgreementTypesIdWorkrolesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementTypeWorkRole>

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

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

financeAgreementTypesIdWorkrolesWorkRoleIdDelete

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

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

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

financeAgreementTypesIdWorkrolesWorkRoleIdGet

financeAgreementTypesIdWorkrolesWorkRoleIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementTypeWorkRole>

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

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

financeAgreementTypesIdWorkrolesWorkRoleIdPatch

financeAgreementTypesIdWorkrolesWorkRoleIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementTypeWorkRole>

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

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

financeAgreementTypesIdWorkrolesWorkRoleIdPut

financeAgreementTypesIdWorkrolesWorkRoleIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementTypeWorkRole>

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

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

Generated using TypeDoc