flexideo

Požadavek save-document

Ukládání instancí dokumentů

Požadavek na transakční uložení XML dokumentu rozkladem do SQL databáze. Používáno pro změny i přidávání (řízeno atributem dkey).

syntax 
<request>
<save-document>
<{fxd-doc-type} dkey="{key}">...</{fxd-doc-type}> *
</save-document>
</request>

Atributy

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


Potomci

Požadavek save-document umožňuje vložit jeden uzel nebo více uzlů flexideo dokument struktury.


Poznámka k request

Potomkem uzlu save-document je přímo kmenový element ukládaného dokumentu. Struktura těchto ukládaných dokumentů viz. příklady save-document nebo též segmenty a metadata dokumentů.


Odpověď

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

syntax 
<response>
<save-result
type="ok|error"
doc-type="{string}"
dkey="{number}"
orig-dkey="{string}"
>
<error ... /> ?
</save-result>
</response>

Atributy

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

doc-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)

orig-dkey - klíč dokumentu - Celočíselný klíč dokumentu nebo řetězec se znakem '#' pro nové instance.(typ: string)


Potomci


Uzel error

Popis uzlu error, který je potomkem uzlu save-result je umístěn v popisu typových uzlů.

Bližší popis viz. error.

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


Poznámka k response

Takže atribut type identifikuje úspěšnost uložení, doc-type vrací informaci o typu uloženého dokumentu, atribut dkey vrací informaci o uložené instanci a atribut orig-dkey vrací původní hodnotu atributu dkey v požadavku (užitečné při zakládání nových dokumentů).

Další informace k možným odpovědím serveru na požadavek ukládání dokumentu najdete v příkladech k save-document a také identifikace chyb při ukládání dokumentů.


Další info

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

Požadavek get-documentPožadavek save-documentPožadavek get-pseudo-documentPožadavek save-pseudo-documentPožadavek get-historyPožadavek erase-documentPožadavek remove-documentPožadavek set-metadata