Požadavek get-versions

Účel a dopady

Vrátí informace o verzích jednotlivých součástí serveru a webové aplikace a některé provozní parametry. Požadavek nic nemění (s výjimkou volitelného vynuceného znovunačtení mezipaměti verzí ze souborů, viz refresh).

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

• Dostupné každému přihlášenému uživateli, bez zvláštních oprávnění.
• Verze načítané ze souborů (intranet, comex, application) se cachují po dobu 30 minut; refresh="true" vynutí okamžité znovunačtení a výsledek ovlivní i všechna další volání od všech uživatelů, dokud znovu neuplyne cache interval.

XML požadavek (syntax + popis)

  <request>
   <get-versions
    refresh="{bool}"
    />
  </request>

Parametry a pravidla (atributy, potomci)

• refresh - Vynutit znovunačtení - Přesná hodnota "true" vynutí okamžité znovunačtení verzí, i kdyby dosud neuplynul interval mezipaměti. (typ: bool; nepovinný; výchozí: false)

Požadavek nemá potomky.

Příklady požadavku

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

Zpracování a vedlejší účinky

• Odpověď obsahuje základní blok atributů build, library, master, supported-auth, default-auth a volitelně auth-uri, start-time. Tento blok stará dokumentace vůbec neznala.
• expiration se do odpovědi zapisuje jen v evaluačních (časově omezených) sestaveních serveru; nejde o běžně dostupný atribut.
• Některá sestavení mohou navíc zapisovat atribut DPA; jeho význam není v tomto rozsahu dokumentován.
• intranet/comex/application se čtou po 30 minutách (nebo na vyžádání přes refresh) ze souborů [web]/fus.xcf, [web]/comex/fus.xcf a [web]/comex/xslt/fus.xcf; chybí-li soubor nebo se v něm nenajde odpovídající version=, atribut se v odpovědi vynechá.
• licenses (počet využívaných licencí) se zapisuje jen tehdy, je-li načten DAD a licenční subsystém je připraven.

XML odpověď (syntax + popis)

  <response>
   <get-versions
    build="{string}"
    library="{string}"
    master="{number}"
    supported-auth="{string}"
    default-auth="{string}"
    auth-uri="{string}"
    start-time="{datetime}"
    expiration="{datetime}"
    history="{string}"
    dad="{string}"
    licenses="{number}"
    intranet="{number}"
    comex="{number}"
    application="{string}"
    />
  </response>

Parametry a pravidla (atributy, potomci) – odpověď

• build - Verze serveru - Verze běžícího serveru. (typ: string)
• library - Verze knihoven - Verze knihoven vilibs slinkovaných do binárního souboru. (typ: string)
• master - MASTER verze - Vypočítaná hlavní verze. (typ: number)
• supported-auth - Podporované autentizační metody. (typ: string)
• default-auth - Výchozí autentizační metoda. (typ: string)
• auth-uri - URI autentizační služby - Přítomno, jen je-li v konfiguraci nastaveno. (typ: string)
• start-time - Čas startu serveru. (typ: datetime)
• expiration - Datum expirace - Přítomno jen u evaluačních sestavení (viz „Zpracování“); na běžném produkčním sestavení se nikdy nezapisuje. (typ: datetime)
• history - Verze DAD složky - Hodnota FOLDERVERSION z konfiguračního souboru. (typ: string)
• dad - Verze načteného DAD - Přítomno, jen je-li DAD načten. (typ: string)
• licenses - Maximální počet využívaných licencí - Přítomno, jen je-li DAD načten a licenční subsystém připraven. Pozor: na rozdíl od staré dokumentace se atribut jmenuje licenses, ne licences. (typ: number)
• intranet - Verze intranetu - Ze souboru [web]/fus.xcf; přítomno, jen byl-li soubor nalezen a rozpoznán. (typ: number)
• comex - Verze comexu - Ze souboru [web]/comex/fus.xcf; přítomno za stejné podmínky. (typ: number)
• application - Verze aplikace - Ze souboru [web]/comex/xslt/fus.xcf; přítomno za stejné podmínky. Pozor: na rozdíl od staré dokumentace se atribut jmenuje application, ne aplication. (typ: string)

Příklady odpovědi

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

Chyby a reakce

get-versions vždy vrací úspěšnou odpověď popsanou výše.

Související požadavky

• get-user – další informační požadavek bez postranních efektů ve stejné skupině.