Exkluzivní zámky na dokumentech - ceskaexpedice/kramerius GitHub Wiki

Získání informace o aktivním zámku

Vrací informace o přiděleném exkluzivním zámku pro daného uživatele.

 GET  ~/client/v7.0/locks/{hash}
Parametr Význam Povinný
hash identifikátor zámku

Návratové kódy: 200, 400, 404

Požádání/Refresh zámku

Získání informace o zámku s aktivním zaznamenáním, že je zámek používán. Podmínkou je, že uživatel musí být přihlášený, musí mít zámek aktivní.

 GET  ~/client/v7.0/locks/{hash}/refresh
Parametr Význam Povinný
hash identifikátor zámku

Příklad odpovědi:

{
    "maxTime": "2024-08-21T15:29:15.592705Z",
    "refreshedTime": "2024-08-21T12:42:35.592705Z",
    "tokenId": "02427359-3ddf-4094-ab61-4311def413c1",
    "refreshInterval": 20,
    "createdTime": "2024-08-21T12:42:35.592705Z",
    "username": "krameriusadmin"
}

Klíče z json odpovědi:

Klíč Datový typ Popis
maxTime Řetězec Datum a čas, do kdy je zámek platný, ve formátu ISO 8601.
refreshedTime Řetězec Datum a čas, kdy byl naposledy obnoven
tokenId Řetězec Identifikátor
refreshInterval Číslo Interval v sekundách, po kterém by měl být zámek obnoven.
createdTime Řetězec Datum a čas, kdy byl zámek vytvořen, ve formátu ISO 8601.
username Řetězec Uživatelské jméno, ke kterému zámek náleží.

Návratové kódy: 200

Uvolnění zámku

Uvolnění používaného zámku

 DELETE  ~/client/v7.0/locks/{hash}

Návratové kódy: 200

Parametr Význam Povinný
hash identifikátor zámku
⚠️ **GitHub.com Fallback** ⚠️