Class UserDefinedFieldsApi

Hierarchy

UserDefinedFieldsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserDefinedFieldsApi(basePath?: string): UserDefinedFieldsApi

- Defined in api/api.ts:100183
Parameters
- Optional basePath: string
Returns UserDefinedFieldsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemUserDefinedFieldsCountGet

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

- Defined in api/api.ts:100196
Get User Defined Fields Count

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

systemUserDefinedFieldsGet

systemUserDefinedFieldsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<UserDefinedField>>

- Defined in api/api.ts:100237
Get User Defined Fields

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

systemUserDefinedFieldsIdDelete

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

- Defined in api/api.ts:100293
Delete User Defined Field By Id

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

systemUserDefinedFieldsIdGet

systemUserDefinedFieldsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<UserDefinedField>

- Defined in api/api.ts:100330
Get User Defined Field By Id

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

systemUserDefinedFieldsIdPatch

systemUserDefinedFieldsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<UserDefinedField>

- Defined in api/api.ts:100368
Update User Defined Field

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

systemUserDefinedFieldsIdPut

systemUserDefinedFieldsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<UserDefinedField>

- Defined in api/api.ts:100413
Replace User Defined Field

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

systemUserDefinedFieldsPost

systemUserDefinedFieldsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<UserDefinedField>

- Defined in api/api.ts:100457
Create User Defined Field

Parameters
- params: object
  - userDefinedField: UserDefinedField
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<UserDefinedField>

Generated using TypeDoc