Function: restoreObjectsByFilter()
ts
function restoreObjectsByFilter(
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:132
Bulk restore objects by archive search filter.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { archivedBy?: string; archivedFromDate?: string; archivedToDate?: string; objectSchemaId?: string; objectTypeIds?: 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.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. |
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; }>