Function: getProgressForCategoryAndResourceId()
ts
function getProgressForCategoryAndResourceId(
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/progress.ts:10
Get progress of ongoing tasks Retrieve the progress of the most recent reindex task /progress/category/insight-reindex/reindex Retrieve the progress of an import task /progress/category/imports/{id}.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { category: string; resourceid: string; } | - |
parameters.category | string | Specifies the type of ongoing task. Possible values include: imports, insight-reindex, freetext-reindex, cache-query, async-task |
parameters.resourceid? | string | Specifies the id of the ongoing task. |
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; }>