Požadavek do-optimize-files
Provádí optimalizaci souborů
Optimalizace zajistí, aby shodné soubory v různých dokumentach byly sloučeny a uloženy ve filesystému pouze jednou.
Uzel obsahující požadavek na plán úlohy.
Základní typ(y) uzlu(ů): do-task;
<request>
<do-optimize-files
validity="{string}"
repeat="{string}"
sched-from-end="{boolean}"
when-off="{boolean}"
failsafe="{string}"
sched-from-end="{boolean}"
del-cache="{string}"
wait-for-lock="{string}"
max-runtime="{string}"
/>
</request>
Atributy
validity - Určuje platnost úlohy. Spec. povinná syntaxe: [once]|today|still|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}] (typ: string) TYP HODNOTY: string;
repeat - Určuje případné opakování úlohy. Spec. povinná syntaxe: [none]|hourly|daily|weekly|monthly|yearly|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}][;each-nn-(minutes|hours|days|weeks|months)[[-xx]...]][;at-{#hh:mm}] (typ: string) TYP HODNOTY: string;
sched-from-end - Říká, zda je interval opakování úlohy počítán od jejího ukončení. Umožňuje přesnější návaznost.(typ: boolean) TYP HODNOTY: boolean;
when-off - Zapíná ošetření při vypnutí. Je-li úloha zadána s when-off=true a vyjde-li její provedení na dobu, kdy je server mimo provoz, dojde ke spuštění úlohy po obnovení činnosti serveru.(typ: boolean) TYP HODNOTY: boolean;
failsafe - Určuje případné opakování úlohy vyskytne-li se při jejím provádění chyba. Syntaxe shodná s nastavením repeat: [none]|hourly|daily|weekly|monthly|yearly|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}][;each-nn-(minutes|hours|days|weeks|months)[[-xx]...]][;at-{#hh:mm}] (typ: string) TYP HODNOTY: string;
sched-from-end - Časování od konce úlohy.(typ: boolean) TYP HODNOTY: boolean;
del-cache - Určuje, zda po dokončení vymazat dokumentovou cache - snižuje šanci na znovupoužití jednou optimalizovaného souboru(typ: string) TYP HODNOTY: string;
wait-for-lock - Pro provedení optimalizace je třeba získat výhradní přístup k souborům, atribut určuje, zda při jeho nezískání skončit, nebo na jeho získání čekat(typ: string) TYP HODNOTY: string;
max-runtime - Maximální doba běhu úlohy(typ: string) TYP HODNOTY: string;
Potomci
Požadavek do-optimize-files neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.
Odpověď
Struktura odpovědi na požadavek do-optimize-files vrácená v obálce response:
<response>
<element
status="ok|error"
detail="{string}"
="{number}"
/>
</response>
Atributy
status - Obsahuje hodnoty ok nebo error
Možnosti obsahu:
» ok ~ Požadavek proveden bez chyb.
» error ~ Při provádění požadavku došlo k chybě.
detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)
- Číslo úlohy vytvořené na serveru, pokud byla úspěšně registrována.(typ: number)
Potomci
Odpověď element neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.