Přejít na obsah
Flexideo
Skip to main content

Požadavek job-list

Účel a dopady​

Vrátí seznam naplánovaných úloh (viz do-import, do-export, do-action aj.), volitelně filtrovaný. Požadavek nic nemění, jen čte.

Dostupnost, kontext, oprávnění apod.​

  • r_admin vidí všechny úlohy bez podmínek.
  • Bez r_admin je požadavek povolen jen tehdy, je-li zároveň zadán platný type odpovídající roli volajícího (import→r_import, export→r_export, action→r_action, request→r_request, forceimport→r_fimport, service/scanfiles→r_manage); jiné typy nebo type neuvedený u ne-admina znamenají zamítnutí. Toto omezení nebylo v dosavadní dokumentaci zmíněno.

XML požadavek (syntax + popis)​

  <request>
   <job-list
    type="{string}"
    id="{number}"
    author="{number}"
    name="{string}"
    running="{bool}"
    />
  </request>

Parametry a pravidla (atributy, potomci)​

  • type - Filtr podle typu úlohy - inthread|system|import|export|forceimport|scanfiles|service|action|request|store|manage|optimizefiles. Neplatná hodnota se tiše ignoruje (chová se jako neuvedený filtr, ne jako chyba). (typ: enum; nepovinný) – dosavadní dokumentace neuváděla hodnoty store, manage, optimizefiles a měla chybný tvar scanfile místo scanfiles.
  • id - Filtr podle čísla úlohy - neplatná hodnota se tiše ignoruje. (typ: number; nepovinný)
  • author - Filtr podle ID uživatele, který úlohu naplánoval - neplatná hodnota se tiše ignoruje. (typ: number; nepovinný)
  • name - Filtr podle názvu úlohy. (typ: string; nepovinný)
  • running - Filtr podle toho, zda úloha právě běží. (typ: bool; nepovinný) – v dosavadní dokumentaci zcela chyběl.

Odebráno jako nepotvrzené atributy požadavku: recuring, sched-from-end, when-off, when-paused, has-failsafe, in-db – dispatcher je jako filtry vůbec nečte; jde výhradně o atributy výstupního uzlu job (viz níže), dosavadní dokumentace je chybně uváděla i jako vstupní filtry.

Požadavek nemá žádné potomky.

Příklady požadavku​

(Zatím bez ověřeného příkladu.)

Zpracování a vedlejší účinky​

Přesná filtrace a sestavení jednotlivých <job> je součástí zpracování na serveru; požadavek předá filtry (id, author, type, name) a příznak r_admin.

XML odpověď (syntax + popis)​

  <response>
   <job-list>
    <job ... /> *
   </job-list>
  </response>

Příklady odpovědi​

(Zatím bez ověřeného příkladu.)

Chyby a reakce​

  • Nedostatečné oprávnění má odpověď <job-list status="error" detail="Nemate patricna opravneni"/>.

Uzel job (tvar převzat z dosavadní dokumentace)​

  <job
   id="{number}"
   type="inthread|system|import|export|forceimport|scanfiles|service|action|request|store|manage|optimizefiles"
   name="{string}"
   author="{number}"
   recuring="{bool}"
   sched-from-end="{bool}"
   when-off="{bool}"
   when-paused="{bool}"
   has-failsafe="{bool}"
   in-db="{bool}"
   next-run="{string}"
   end-time="{string}"
   />

Atributy odpovídají stejnojmenným plánovacím vlastnostem úlohy (viz do-task); přesný výčet a podmínky přítomnosti jsou převzaty z dosavadní dokumentace jako neověřený předpoklad.

Související požadavky​