Function: findObject()

function findObject(
   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/objects.ts:315

Retrieve a list of objects based on an AQL query.

Parameters

Parameter	Type
client	Client
parameters	{ asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; includeAttributes?: boolean; iql?: string; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; qlQuery?: string; resultsPerPage?: number; }
parameters.asc?	number
parameters.attributesToDisplay?	{ attributesToDisplayIds?: number[]; }
parameters.attributesToDisplay.attributesToDisplayIds?	number[]
parameters.includeAttributes?	boolean
parameters.iql?	string
parameters.objectId?	number
parameters.objectSchemaId?	number
parameters.objectTypeId?	number
parameters.orderByTypeAttrId?	number
parameters.page?	number
parameters.qlQuery?	string
parameters.resultsPerPage?	number
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; }>