Skip to main content

Požadavek get-document

Získat flexideo dokumnet(y)

Požadavek na XML jednoho nebo několika dokumentů poskládaných z databáze flexideo serverem.

  <request>
   <get-document>
    <document ... /> *
   </get-document>
  </request>

Atributy​

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

Potomci​

Odpověď​

Bližší popis viz. document-set.

Poznámka k response​

Zažádáte-li o instanci dokumentu, která neexistuje nebo zažádáte-li o typ dokumentu, který neexistuje, server vrátí prázdný uzel document-set, ale negeneruje žádný druh chyby. Na to je zapotřebí dávat pozor zejména při požadavku na více dokumentů v jedné obálce response či v jednom uzlu get-document, protože v tom případě server vrátí jen ty dokumenty, které nalezl a při multipožadavku je třeba v případě kritičnosti tohoto problému získaný počet ověřovat.

Stejně tak se server zachová, uvedete-li prázdný některý z atributů, případně oba nebo pokud je neuvedete vůbec. Ani toto server neidentifikuje jako chybu, jen vrací prázdný document-set (případně vrací jen ty dokumenty, jejichž požadavek byl vůči databázi platný).

Další info​

Součástí získávaných dokumentů jsou metadata v atributech samotného dokumentu. Jde zejména o klíče, ale i další pomocné informace. Více viz. segmenty a metadata dokumentů.

Uzel document​

Uzel se specifikací typu a instace požadovaného dokumentu.

  <document
   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 document neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.