Function: findObjectsByAql()

function findObjectsByAql(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  last: boolean;
  maxResults: number;
  objectTypeAttributes: object[];
  startAt: number;
  values: object[];
}>;

Defined in: src/assets/api/objects.ts:149

Fetch Objects by AQL

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ includeAttributes?: boolean; maxResults?: number; qlQuery: string; startAt?: number; }	-
parameters.includeAttributes?	boolean	Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present
parameters.maxResults?	number	The maximum number of objects to return in this page of results. Actual number of results may be less, for example, if the last page of results is returned.
parameters.qlQuery?	string	The AQL that will fetch the objects.
parameters.startAt?	number	The starting index for the next page of results
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; last: boolean; maxResults: number; objectTypeAttributes: object[]; startAt: number; values: object[]; }>