Class BoardItemsApi

Hierarchy

BoardItemsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BoardItemsApi(basePath?: string): BoardItemsApi

- Defined in api/api.ts:21827
Parameters
- Optional basePath: string
Returns BoardItemsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceBoardsIdItemsCountGet

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

- Defined in api/api.ts:21841
Get Items Count

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

serviceBoardsIdItemsGet

serviceBoardsIdItemsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<BoardItem>>

- Defined in api/api.ts:21888
Get Items

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

serviceBoardsIdItemsItemIdDelete

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

- Defined in api/api.ts:21950
Delete Item By Id

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

serviceBoardsIdItemsItemIdGet

serviceBoardsIdItemsItemIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardItem>

- Defined in api/api.ts:21993
Get Item By Id

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

serviceBoardsIdItemsItemIdPatch

serviceBoardsIdItemsItemIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardItem>

- Defined in api/api.ts:22037
Update Item

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

serviceBoardsIdItemsItemIdPut

serviceBoardsIdItemsItemIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardItem>

- Defined in api/api.ts:22088
Replace Item

Parameters
- params: object
  - boardItem: BoardItem
  - id: number
  - itemId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BoardItem>

serviceBoardsIdItemsPost

serviceBoardsIdItemsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardItem>

- Defined in api/api.ts:22138
Create Item

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

Generated using TypeDoc