Function: getArticles()

function getArticles(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDesk/api/knowledgebase.ts:16

Returns articles which match the given query string across all service desks.

Permissions required: Permission to access the customer portal.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; highlight: boolean; limit?: number; prev?: boolean; query: string; start?: number; }	-
parameters.cursor?	string	Pointer to a set of search results, returned as part of the next or prev URL from the previous search call.
parameters.highlight?	boolean	If set to true matching query term in the title and excerpt will be highlighted using the @@@hl@@@term@@@endhl@@@ syntax. Default: false.
parameters.limit?	number	The maximum number of items to return per page. Default: 50.
parameters.prev?	boolean	Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call.
parameters.query?	string	The string used to filter the articles (required).
parameters.start?	number	(Deprecated) The starting index of the returned objects. Base index: 0.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }>