Skip to main content

Požadavek get-history

Získání informací z historie fxd dokumentu/ů.

Požadavky pro získávání informací z evidence historie dokumentů.

  <request>
   <get-history>
    <list ... /> ?
    <document ... /> ?
   </get-history>
  </request>

Atributy​

Požadavek get-history neobsahuje žádné atributy.

Potomci​

Odpověď​

Struktura odpovědi na požadavek get-history vrácená v obálce response:

  <response>
   <history-list
    type="ok|error"
    detail="{string}"
    >
    <{element} ... > ... </{element}>+
   </history-list>
  </response>

Atributy​

  • type - Obsahuje hodnoty ok nebo error (možnosti obsahu: ok | error)

  • detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)

Potomci​

Odpověď history-list umožňuje uvést min. jeden element: Uzel historie dle typu dokumentu - Uzel nesoucí jméno dokumentového typu a atributy definující jeho instanci běžnou (dkey) a také instanci v evidenci historie (id). Dále pak číslo uživatele, jež je autorem historické změny (author) a datum (date) a čas (time) této historické úpravy.

Struktura odpovědi na požadavek get-history vrácená v obálce response:

  <response>
   <history-doc
    type="ok|error"
    detail="{string}"
    >
    <{fxd-doc-type} dkey="{key}">...</{fxd-doc-type}> *
   </history-doc>
  </response>

Atributy​

  • type - Obsahuje hodnoty ok nebo error (možnosti obsahu: ok | error)

  • detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)

Potomci​

Odpověď history-doc umožňuje vložit jeden uzel nebo více uzlů flexideo dokument struktury.

Výraz pro identifikaci chyb v odpovědi serveru: history-list[@type='error'] (odkaz na popis detailu: @detail).

Další info​

Viz. též příklady na získání historie dokumentu.

Uzel list​

Dotaz na seznam všech změn určité instance určitého typu dokumentu.

  <list
   type="{string}"
   dkey="{number}"
   />

Atributy​

  • type - typ dokumentu - Typový název dokumentu definovaného v XDS.(typ: string)

  • dkey - PDK dokumentu - Primární klíč instance typu dokumentu dle databáze.(typ: number)

Potomci​

Uzel list neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.

Uzel document​

Požadavek na vrácení podoby, kompletního obsahu, jedné konkrétní položky ze seznamu historických stavů (dle id).

  <document
   type="{string}"
   dkey="{number}"
   id="{number}"
   />

Atributy​

  • type - typ dokumentu - Typový název dokumentu definovaného v XDS.(typ: string)

  • dkey - PDK dokumentu - Primární klíč instance typu dokumentu dle databáze.(typ: number)

  • id - číslo uživatele - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)

Potomci​

Uzel document neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.