Class LinksApi

Hierarchy

LinksApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LinksApi(basePath?: string): LinksApi

- Defined in api/api.ts:52892
Parameters
- Optional basePath: string
Returns LinksApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemLinksCountGet

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

- Defined in api/api.ts:52905
Get Links Count

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

systemLinksGet

systemLinksGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Link>>

- Defined in api/api.ts:52946
Get Links

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

systemLinksIdDelete

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

- Defined in api/api.ts:53002
Delete Link By Id

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

systemLinksIdGet

systemLinksIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Link>

- Defined in api/api.ts:53039
Get Link By Id

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

systemLinksIdPatch

systemLinksIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Link>

- Defined in api/api.ts:53077
Update Link

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

systemLinksIdPut

systemLinksIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Link>

- Defined in api/api.ts:53122
Replace Link

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

systemLinksPost

systemLinksPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Link>

- Defined in api/api.ts:53166
Create Link

Parameters
- params: object
  - link: Link
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Link>

Generated using TypeDoc