Class BoardStatusesApi

Hierarchy

BoardStatusesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BoardStatusesApi(basePath?: string): BoardStatusesApi

- Defined in api/api.ts:23620
Parameters
- Optional basePath: string
Returns BoardStatusesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceBoardsIdStatusesCountGet

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

- Defined in api/api.ts:23634
Get Statuses Count

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

serviceBoardsIdStatusesGet

serviceBoardsIdStatusesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<BoardStatus>>

- Defined in api/api.ts:23681
Get Statuses

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

serviceBoardsIdStatusesPost

serviceBoardsIdStatusesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardStatus>

- Defined in api/api.ts:23743
Create Statuses

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

serviceBoardsIdStatusesStatusIdDelete

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

- Defined in api/api.ts:23788
Delete Status By Id

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

serviceBoardsIdStatusesStatusIdGet

serviceBoardsIdStatusesStatusIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardStatus>

- Defined in api/api.ts:23831
Get Status By Id

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

serviceBoardsIdStatusesStatusIdPatch

serviceBoardsIdStatusesStatusIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardStatus>

- Defined in api/api.ts:23875
Update Status

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

serviceBoardsIdStatusesStatusIdPut

serviceBoardsIdStatusesStatusIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardStatus>

- Defined in api/api.ts:23926
Replace Statuses

Parameters
- params: object
  - boardStatus: BoardStatus
  - id: number
  - statusId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BoardStatus>

Generated using TypeDoc