Function: getArchivedObjects()

function getArchivedObjects(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  count?: number;
  limit?: number;
  offset?: number;
  results?: object[];
  total?: number;
}>;

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

Retrieve archived objects.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ archivedBy?: string; archivedFromDate?: string; archivedToDate?: string; limit?: string; objectSchemaId?: string; objectTypeIds?: string; offset?: string; }	-
parameters.archivedBy?	string	A list of users that archived the objects. Optional. If not set, all users will be searched for.
parameters.archivedFromDate?	string	Timestamp in ISO Offset Date Time format e.g. 2021-12-03T10:15:30+01:00. Only objects archived at or after this time will be displayed. Optional.
parameters.archivedToDate?	string	Timestamp in ISO Offset Date Time format e.g. 2021-12-03T10:15:30+01:00. Only objects archived before this time will be displayed. Must be after archivedFromDate, if both are set. Optional.
parameters.limit?	string	The maximum number of objects to return. Optional.
parameters.objectSchemaId?	string	The id of the object schema to search for.
parameters.objectTypeIds?	string	A list of object type ids to search for. Optional. If not set, all object types within the schema will be searched for.
parameters.offset?	string	The offset of the first object to return. Optional.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; count?: number; limit?: number; offset?: number; results?: object[]; total?: number; }>