flexideo

Požadavek erase-document

Slouží k “promazání” jednotlivých polí dokumentu.

Požadavek erase-document vymaže (nahradí) pouze konkrétní informace, ale dokument ponechá včetně jeho vazeb na ostatní dokumenty.

syntax 
<request>
<erase-document>
<pdk-list ... /> ?
</erase-document>
</request>

Atributy

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


Potomci


Uzel pdk-list

Popis uzlu pdk-list, který je potomkem uzlu erase-document je umístěn v popisu typových uzlů.

Bližší popis viz. pdk-list.


Odpověď

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

syntax 
<response>
<erase-document
status="ok|error"
detail="{string}"
>
<document ... /> *
</erase-document>
</response>

Atributy

status - Obsahuje hodnoty ok nebo error

Možnosti obsahu:

» ok ~ Požadavek proveden bez chyb.

» error ~ Při provádění požadavku došlo k chybě.

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


Potomci


Uzel document

syntax 
<document
type="{string}"
status="ok|error"
dkey="{string}"
>
<error ... /> ?
</document>

Atributy

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

status - Obsahuje hodnoty ok nebo error

Možnosti obsahu:

» ok ~ Požadavek proveden bez chyb.

» error ~ Při provádění požadavku došlo k chybě.

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


Potomci

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

Bližší popis viz. error.

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

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