Přeskočit na hlavní obsah

Obnovení ze zálohy

Obnovení firmy ze zálohy v REST API

Autor: Petr Pech

Získání zálohy

Pomocí REST API lze získat zálohu firmy takto:

GET /c/db_nazev/backup
  • uvedete-li hlavičku Accept, musí nabývat hodnoty application/x-winstrom-backup (případně application/octet-stream),

  • odpověď má Content-Type: application/x-winstrom-backup.

ℹ️ Při jiné hodnotě hlavičky Accept (např. application/json) server odpoví 406 Not Acceptable.


Obnovení ze zálohy

Firmu lze ze zálohy pomocí REST API i obnovit:

PUT /c/db_nazev/restore?name=Firma
  • parametr name je volitelný — pokud není uveden, použije se název z posledního platného nastavení firmy,

  • v těle požadavku musí být záloha firmy,

  • uvedete-li hlavičku Content-Type, musí nabývat hodnoty application/x-winstrom-backup (případně application/octet-stream) — jinak server odpoví 415 Unsupported Media Type.

⚠️ Obnovovaná firma nesmí existovat, při obnovení bude teprve založena. Pokud už firma existuje, server odpoví 400 a hláškou Company 'db_nazev' already exists — v hlášce je uveden databázový identifikátor z URL, ne hodnota parametru name.

Pokud uvedete v identifikátoru firmy nepovolený znak, dojde k přesměrování na URL s platným identifikátorem.


Obnovení testovací firmy

Při obnovení ze zálohy je také možné firmu označit jako testovací a vypnout funkce, které nejsou při testování žádoucí. Slouží k tomu parametr forTesting=1:

PUT /c/db_nazev/restore?name=Firma&forTesting=1

V tomto režimu je navíc možné specifikovat, které funkce mají být vypnuty. Implicitně (při neuvedení) mají parametry hodnotu 1, při níž dochází k vypnutí odpovídající funkce. Pokud nemá k vypnutí dojít, uveďte parametr s hodnotou 0.

Funkce, které je možné vypnout:

disableEet

Dojde k vypnutí odesílání zpráv do EET. Ve všech platnostech nastavení firmy dojde ke změně vlastnosti Mód komunikace (na záložce Automatické operace — EET) na hodnotu Vypnuto.

disableAutoSendMail

Vypne automatické odesílání mailů. Ve všech platnostech nastavení firmy dojde ke změně vlastnosti Automaticky odesílat doklady mailem (na záložce Ostatní) na hodnotu Neodesílat.

disableWebHooks

Odregistruje všechny Web Hooky, které jsou ve firmě registrovány.

skipZurnal

Volitelný parametr — neobnovit historii změn.

skipChangelog

Volitelný parametr — neobnovit historii Changes API.

URL pak může vypadat například takto:

PUT /c/db_nazev/restore?name=Firma&forTesting=1&disableAutoSendMail=0&skipZurnal


Související

Dostali jste odpověď na svou otázku?