Function: archiveObjectsByFilter()

function archiveObjectsByFilter(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  finishedDate?: Date;
  numberOfSteps?: number;
  progressInPercent?: number;
  resourceId?: string;
  result?: string;
  resultData?: Record<string, any>;
  resultMessage?: string;
  startDate?: Date;
  status?: string;
  stepDescription?: string;
  totalWorkUnits?: number;
}>;

Defined in: src/assetsServer/api/objects.ts:72

Bulk archive objects of an object type by filter.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ filterParams?: { asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; attributesToDisplayIds?: number[]; filters?: object[]; includeAttributes?: boolean; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; resultsPerPage?: number; }; iqlParams?: { asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; includeAttributes?: boolean; iql?: string; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; qlQuery?: string; resultsPerPage?: number; }; iqlSearch?: boolean; objectSchemaId?: number; qlQueryParams?: { asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; includeAttributes?: boolean; iql?: string; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; qlQuery?: string; resultsPerPage?: number; }; qlQuerySearch?: boolean; typeId?: string; }	-
parameters.filterParams?	{ asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; attributesToDisplayIds?: number[]; filters?: object[]; includeAttributes?: boolean; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; resultsPerPage?: number; }	-
parameters.filterParams.asc?	number	-
parameters.filterParams.attributesToDisplay?	{ attributesToDisplayIds?: number[]; }	-
parameters.filterParams.attributesToDisplay.attributesToDisplayIds?	number[]	-
parameters.filterParams.attributesToDisplayIds?	number[]	-
parameters.filterParams.filters?	object[]	-
parameters.filterParams.includeAttributes?	boolean	-
parameters.filterParams.objectId?	number	-
parameters.filterParams.objectSchemaId?	number	-
parameters.filterParams.objectTypeId?	number	-
parameters.filterParams.orderByTypeAttrId?	number	-
parameters.filterParams.page?	number	-
parameters.filterParams.resultsPerPage?	number	-
parameters.iqlParams?	{ asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; includeAttributes?: boolean; iql?: string; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; qlQuery?: string; resultsPerPage?: number; }	-
parameters.iqlParams.asc?	number	-
parameters.iqlParams.attributesToDisplay?	{ attributesToDisplayIds?: number[]; }	-
parameters.iqlParams.attributesToDisplay.attributesToDisplayIds?	number[]	-
parameters.iqlParams.includeAttributes?	boolean	-
parameters.iqlParams.iql?	string	-
parameters.iqlParams.objectId?	number	-
parameters.iqlParams.objectSchemaId?	number	-
parameters.iqlParams.objectTypeId?	number	-
parameters.iqlParams.orderByTypeAttrId?	number	-
parameters.iqlParams.page?	number	-
parameters.iqlParams.qlQuery?	string	-
parameters.iqlParams.resultsPerPage?	number	-
parameters.iqlSearch?	boolean	-
parameters.objectSchemaId?	number	-
parameters.qlQueryParams?	{ asc?: number; attributesToDisplay?: { attributesToDisplayIds?: number[]; }; includeAttributes?: boolean; iql?: string; objectId?: number; objectSchemaId?: number; objectTypeId?: number; orderByTypeAttrId?: number; page?: number; qlQuery?: string; resultsPerPage?: number; }	-
parameters.qlQueryParams.asc?	number	-
parameters.qlQueryParams.attributesToDisplay?	{ attributesToDisplayIds?: number[]; }	-
parameters.qlQueryParams.attributesToDisplay.attributesToDisplayIds?	number[]	-
parameters.qlQueryParams.includeAttributes?	boolean	-
parameters.qlQueryParams.iql?	string	-
parameters.qlQueryParams.objectId?	number	-
parameters.qlQueryParams.objectSchemaId?	number	-
parameters.qlQueryParams.objectTypeId?	number	-
parameters.qlQueryParams.orderByTypeAttrId?	number	-
parameters.qlQueryParams.page?	number	-
parameters.qlQueryParams.qlQuery?	string	-
parameters.qlQueryParams.resultsPerPage?	number	-
parameters.qlQuerySearch?	boolean	-
parameters.typeId?	string	The object type id to archive.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; actor?: string; category?: string; currentStep?: number; currentStepTotalWorkUnits?: number; currentWorkDescription?: string; currentWorkUnits?: number; estimatedFinishDate?: Date; finishedDate?: Date; numberOfSteps?: number; progressInPercent?: number; resourceId?: string; result?: string; resultData?: Record<string, any>; resultMessage?: string; startDate?: Date; status?: string; stepDescription?: string; totalWorkUnits?: number; }>