Požadavek job-list
Seznam naplánovaných úloh
Požadavek na seznam úloh, které byly naplánovány pomocí nastavení validity a nebo repeat; viz. validity & repeat.
<request>
<job-list
type="inthread|system|import|export|forceimport|scanfile|service|action|request"
id="{number}"
name="{string}"
author="{number}"
recuring="{boolean}"
sched-from-end="{boolean}"
when-off="{boolean}"
when-paused="{boolean}"
has-failsafe="{boolean}"
in-db="{boolean}"
/>
</request>
Atributy
type - Základní typ naplánované úlohy: inthread|system|import|export|forceimport|scanfile|service|action|request(typ: string)
Možnosti obsahu:
» inthread
» system
» import
» export
» forceimport
» scanfile
» service
» action
» request
» inthread ~ systemová uloha prováděná ve vlakně cronu
» system ~ systemová úloha prováděná v samostatném vlakně
» import ~ import dat požadavkem »do-import«
» export ~ export dat požadavkem »do-export«
» forceimport ~ import velkých dat s vynuceným pozastavením serveru požadavkem »do-force-import«
» scanfile ~ správa přikládaných souborů spouštěná požadavkem »do-scan-files«
» service ~ spouštění a zastavování služeb
» action ~ plán SOAP akce spuštěné přes běžný XML (solve) protokol serveru (požadavek »do-action«)
» request ~ spouštění běžných XML požadavků přes »do-request« s odložením či opakováním
id - Číslo úlohy přidělené serverem.(typ: number) TYP HODNOTY: number;
name - Název naplánované úlohy, například akce(typ: string) TYP HODNOTY: string;
author - Číslo (pdk) uživatele, který úlohu naplánoval.(typ: number) TYP HODNOTY: number;
recuring - Říká, zda je úloha opakovatelná.(typ: boolean) TYP HODNOTY: boolean;
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 - Informuje o zajištění provedení úlohy při pozastavení serveru (jen pro systémové úlohy).(typ: boolean) TYP HODNOTY: boolean;
when-paused - Informuje o zajištění provedení úlohy při vypnutí serveru ihned po jeho obnovení.(typ: boolean) TYP HODNOTY: boolean;
has-failsafe - Uvádí, zda má úloha nastaveno failsafe (tedy opakování při vzniku chyby).(typ: boolean) TYP HODNOTY: boolean;
in-db - Říká, zda je úloha uložena v databázi (většina krom systémových)(typ: boolean) TYP HODNOTY: boolean;
Potomci
Požadavek job-list neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.
Odpověď
Struktura odpovědi na požadavek job-list vrácená v obálce response:
<response>
<job-list>
<job ... /> ?
</job-list>
</response>
Atributy
Odpověď job-list neobsahuje žádné atributy.
Potomci
Poznámka k response
Opět kmenový atribut type ve výstupním uzlu identifikuje chybu, pokud neobsahuje hodnotu ok vypadá následovně:
>job-list type="error" detail="Popis chyby"/<
Došlo-li k chybě při sestavování požadovaných úloh, je seznam prázdný.