Projekty, štítky a sdílení
Souborová knihovna je zdrojem pravdy pro zdroje; projekty, štítky a vyhledávání jsou zobrazení, která je organizují. Zachovejte ID souborů nebo dokumentů; nepoužívejte názvy místo stabilních identifikátorů.
Projekty
Section titled “Projekty”GET /api/v1/projectsPOST /api/v1/projectsGET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documentsDELETE /api/v1/projects/{project_id}/documents/{document_id}Přidání dokumentu do projektu pouze změní jeho organizaci: soubor se nekopíruje a jeho vlastník se nemění.
Štítky
Section titled “Štítky”GET /api/v1/tagsPOST /api/v1/tagsDELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}DELETE /api/v1/tags/documents/{document_id}/{tag_id}Název tagu slouží k zobrazení; pro mazání, odpojování a dotazování se používá ID tagu.
Hledat
Section titled “Hledat”GET /api/v1/search?q={query}&limit=20Vyhledávání vrátí pouze dokumenty a úlohy, které může aktuální účet číst. Vyhledávání je operací čtení a nevyužívá žádné kredity.
Sdílet odkazy
Section titled “Sdílet odkazy”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares vytvoří odkaz pouze pro čtení na výsledek překladu; tělo obsahuje artifact_id a volitelné expires_in_days (1–365; bez něj odkaz nevyprší). Každý, kdo má tento odkaz, může soubor stáhnout, proto jej uchovejte mimo protokoly a parametry analytických nástrojů a odstraňte ho, jakmile již není potřeba.
Prostor aplikace
Section titled “Prostor aplikace”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsTyto koncové body slouží k vytvoření sjednoceného pracovního prostoru pro účet OmniDoc. Klienti by měli používat hodnoty a funkce uvedené v odpovědích a sami si nemají sestavovat URL adresy aplikací.