5.14.4 api dir delete

Funkce /api/dir/delete slouží k vymazávání pole záznamů v adresáři.

Skupiny služeb a privilegií

  • Služba je System.
  • Privilegia jsou Systém – řízení.

Metody

  • PUT


Požadavek

Požadavek obsahuje parametry ve formátu application/json.

Tabulka 1. Klíče požadavku JSON
Název klíčePovinnýOčekávané hodnotyVýchozí hodnotaPopis

owner

Ano, pokud users je omitted

řetězec

-

Všechny záznamy v adresáři se zadaným vlastníkem budou vymazány.

users

Ano, pokud owner je omitted

pole JSON objektů definujících identifikátory uuid

-

Pole musí obsahovat alespoň jeden objekt s klíčem uuid, který definuje, které pole má být vymazáno.

Příklad požadavku

URL: https://192.168.1.1/api/dir/delete JSON (owner specified) { "owner": "My2N" } JSON (uuid specified) { "users": [ { "uuid": "01234567-89AB-CDEF-0123-456789ABCDEF" }, { "uuid": "76543210-68FF-18CA-3210-FEDCBA987654" }, { "uuid": "76543210-68FF-18-3210-FEDCBA987654" } ] }

Pokud není v adresáři žádný záznam se zadaným vlastníkem, vrátí se prázdné pole.


Pokud není v adresáři žádné pole se zadaným uuid 01234567-89AB-CDEF-0123-456789ABCDEF, zařízení odpoví chybovým kódem (viz dále). To samé platí pro druhý uuid 76543210-68FF-18CA-3210-FEDCBA987654.


Jestliže je v adresáři záznam s uuid 01234567-89AB-CDEF-0123-456789ABCDEF, bude vymazán. To samé platí pro druhý uuid 76543210-68FF-18CA-3210-FEDCBA987654.

Třetí uuid má nesprávný formát a vrátí se chyba.


Odpověď

Odpověď je ve formátu application/json. Objekt result obsahuje klíče series a users.


Více informací o použití klíče series najdete v kapitole api/dir/query.


Klíč users obsahuje pole objektů, které obsahují klíče uuid a timestamp.


  • Více o struktuře JSON odpovědi se dozvíte z příkladu na konci této kapitoly.
Tabulka 2. Klíče odpovědi JSON v poli users
KlíčTypické vrácené hodnotyPopis

uuid

uuid

Unikátní uživatelský identifikátor (Unique User Identifier) vymazaného nebo nezměněného záznamu.

timestamp

celé číslo

Časová značka změn provedených v adresáři. Více informací o použití časové značky najdete v kapitole api/dir/query. Časová značka je uvedena, jen když je změna v adresáři provedena úspěšně.

errors

pole chybových objektů

Chybový objekt obsahující pole všech chyb, které nastaly. Objekt errors je uveden, jen když se změnu v adresáři nepodařilo provést.

V hodnotě klíče code je obsažen chybový kód, který ukazuje důvod neúspěšného provedení změny v adresáři.

V odpovědi se mohou vrátit následující chybové kódy:

  • EDIR_UUID_DOES_NOT_EXIST - záznam se zadaným identifikátorem uuid neexistuje (tj. nedá se vymazat).

  • EDIR_UUID_INVALID_FORMAT - uuid nemá platný formát, který je "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", kde X může být jakákoli hexadecimální číslice. Všechny nuly jsou rezervovány jako prázdný uuid.


Příklad odpovědi

{ "success": true, "result": { "series": "6423407687606431951", "users": [ { "uuid": "01234567-89AB-CDEF-0123-456789ABCDEF", "timestamp": 39 }, { "uuid": "76543210-68FF-18CA-3210-FEDCBA987654", "errors": [ { "code": "EDIR_UUID_DOES_NOT_EXIST" } ] }, { "uuid": "76543210-68FF-18-3210-FEDCBA987654", "errors": [ { "code": "EDIR_UUID_INVALID_FORMAT" } ] } ] } }

První záznam v adresáři je úspěšně vymazán, vrátí se jeho uuid a timestamp změny.


Druhý záznam neexistuje (neexistuje záznam s daným uuid).


Třetí objekt má špatný formát uuid.