Class KnowledgeBaseArticlesApi

Hierarchy

KnowledgeBaseArticlesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KnowledgeBaseArticlesApi(basePath?: string): KnowledgeBaseArticlesApi

- Defined in api/api.ts:50064
Parameters
- Optional basePath: string
Returns KnowledgeBaseArticlesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceKnowledgeBaseArticlesCountGet

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

- Defined in api/api.ts:50078
Get Knowledge Base Articles Count

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

serviceKnowledgeBaseArticlesGet

serviceKnowledgeBaseArticlesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<KnowledgeBaseArticle>>

- Defined in api/api.ts:50123
Get Knowledge Base Articles

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

serviceKnowledgeBaseArticlesIdDelete

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

- Defined in api/api.ts:50179
Delete Knowledge Base Article By Id

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

serviceKnowledgeBaseArticlesIdGet

serviceKnowledgeBaseArticlesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<KnowledgeBaseArticle>

- Defined in api/api.ts:50216
Get Knowledge Base Article By Id

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

serviceKnowledgeBaseArticlesIdPatch

serviceKnowledgeBaseArticlesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<KnowledgeBaseArticle>

- Defined in api/api.ts:50254
Update Knowledge Base Article

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

serviceKnowledgeBaseArticlesIdPut

serviceKnowledgeBaseArticlesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<KnowledgeBaseArticle>

- Defined in api/api.ts:50299
Replace Knowledge Base Article

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

serviceKnowledgeBaseArticlesPost

serviceKnowledgeBaseArticlesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<KnowledgeBaseArticle>

- Defined in api/api.ts:50343
Create Knowledge Base Article

Parameters
- params: object
  - knowledgeBaseArticle: KnowledgeBaseArticle
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<KnowledgeBaseArticle>

Generated using TypeDoc