Function: startImport()
ts
function startImport(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
actor?: string;
category?: string;
currentStep?: number;
currentStepTotalWorkUnits?: number;
currentWorkDescription?: string;
currentWorkUnits?: number;
estimatedFinishDate?: Date;
executionUUID?: string;
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/assets/api/imports.ts:6
Start configured imports. To see an ongoing import see the Progress resource
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { id: string; } | - |
parameters.id | string | The id of the import configuration that should be started |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; actor?: string; category?: string; currentStep?: number; currentStepTotalWorkUnits?: number; currentWorkDescription?: string; currentWorkUnits?: number; estimatedFinishDate?: Date; executionUUID?: string; finishedDate?: Date; numberOfSteps?: number; progressInPercent?: number; resourceId?: string; result?: string; resultData?: Record<string, any>; resultMessage?: string; startDate?: Date; status?: string; stepDescription?: string; totalWorkUnits?: number; }>