Class AgreementWorkRolesApi

Hierarchy

AgreementWorkRolesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgreementWorkRolesApi(basePath?: string): AgreementWorkRolesApi

- Defined in api/api.ts:17538
Parameters
- Optional basePath: string
Returns AgreementWorkRolesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAgreementsIdWorkrolesCountGet

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

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

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

financeAgreementsIdWorkrolesGet

financeAgreementsIdWorkrolesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<AgreementWorkRole>>

- Defined in api/api.ts:17599
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<AgreementWorkRole>>

financeAgreementsIdWorkrolesPost

financeAgreementsIdWorkrolesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementWorkRole>

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

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

financeAgreementsIdWorkrolesWorkRoleIdDelete

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

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

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

financeAgreementsIdWorkrolesWorkRoleIdGet

financeAgreementsIdWorkrolesWorkRoleIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementWorkRole>

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

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

financeAgreementsIdWorkrolesWorkRoleIdPatch

financeAgreementsIdWorkrolesWorkRoleIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementWorkRole>

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

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

financeAgreementsIdWorkrolesWorkRoleIdPut

financeAgreementsIdWorkrolesWorkRoleIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AgreementWorkRole>

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

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

Generated using TypeDoc