Function: findObjects()

function findObjects(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  abstractObjectType?: boolean;
  conversionPossible?: boolean;
  filters?: object[];
  inheritanceTree?: {
   [key: string]: unknown;
     parentObjectTypeIdsInclSelf?: Record<string, any>;
  };
  iql?: string;
  iqlSearchResult?: boolean;
  matchedFilterValues?: ObjectAttribute[];
  objectEntries?: AssetObject[];
  objectTypeAttributes?: object[];
  objectTypeId?: number;
  objectTypeIsInherited?: boolean;
  orderAscending?: boolean;
  orderByTypeAttrId?: number;
  orderWay?: string;
  pageNumber?: number;
  pageObjectSize?: number;
  pageSize?: number;
  qlQuery?: string;
  qlQuerySearchResult?: boolean;
  startIndex?: number;
  toIndex?: number;
  totalFilterCount?: number;
}>;

Defined in: src/assetsServer/api/aql.ts:6

Find objects using AQL.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ includeAttributes?: string; includeAttributesDeep?: string; includeExtendedInfo?: string; includeTypeAttributes?: string; page?: string; qlQuery?: string; resultPerPage?: string; xoauth_requestor_id?: string; }	-
parameters.includeAttributes?	string	Should object attributes be included in the response. If this parameter is set to false, only the information on the object will be returned and object attributes will not be present.
parameters.includeAttributesDeep?	string	How many levels of attributes should be included in the response. Example: Consider object A, which has a reference to object B, which has a reference to object C. If object A is included in the response and includeAttributesDeep=1, object A's reference to object B will be included in the attributes of object A but object B's reference to object C will not be included. However if includeAttributesDeep=2, then object B's reference to object C will be included in object B's attributes.
parameters.includeExtendedInfo?	string	Should the response include information about open issues and attachments. If the value is set to true, each returned object contains information on whether there are open tickets connected to it and if the object has attachments.
parameters.includeTypeAttributes?	string	Should the response include the object type attribute definition for each attribute that is returned with the objects.
parameters.page?	string	The page to fetch when paginating through the response.
parameters.qlQuery?	string	The query to determine which objects should be fetched. For example, objectType = "Computer". An empty query means all objects are fetched.
parameters.resultPerPage?	string	The number of objects returned per page.
parameters.xoauth_requestor_id?	string	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; abstractObjectType?: boolean; conversionPossible?: boolean; filters?: object[]; inheritanceTree?: { [key: string]: unknown; parentObjectTypeIdsInclSelf?: Record<string, any>; }; iql?: string; iqlSearchResult?: boolean; matchedFilterValues?: ObjectAttribute[]; objectEntries?: AssetObject[]; objectTypeAttributes?: object[]; objectTypeId?: number; objectTypeIsInherited?: boolean; orderAscending?: boolean; orderByTypeAttrId?: number; orderWay?: string; pageNumber?: number; pageObjectSize?: number; pageSize?: number; qlQuery?: string; qlQuerySearchResult?: boolean; startIndex?: number; toIndex?: number; totalFilterCount?: number; }>