| soubory | |
|---|---|
| Popis | Soubory v IS/STAG |
| Typ | REST |
| Adresa | /ws/services/rest2/soubory |
| Specifikace | |
| Název | soubory |
Operace
| getSouborContent | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí obsah zadaného souboru. Služba sama o sobě nevyžaduje přihlášení (ovšem soubor případně nevydá, pokud to u něj není povoleno) |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getSouborContent |
| Možné výstupní MIME typy | */* |
| Oblasti | root, downloads |
| Je nutné ověřování | pravděpodobně bez nutnosti přihlášení (služba ovšem na základě konfigurace konkrétní instalace IS/STAG může vyžadovat přihlášení či specifickou roli uživatele) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| soubIdno | long | |||
| getSouborContentAuth | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí obsah zadaného souboru. Služba vždy vyžaduje přihlášení |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getSouborContentAuth |
| Možné výstupní MIME typy | */* |
| Oblasti | root, downloads |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
ALL
|
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| soubIdno | long | |||
| getSouborContentForThesesCZ | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí obsah zadaného souboru. Určeno pouze pro komunikaci s Theses.CZ |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getSouborContentForThesesCZ |
| Možné výstupní MIME typy | */* |
| Oblasti | root, downloads |
| Je nutné ověřování | přihlášení, ověření speciálním uživatelským účtem |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| soubIdno | long | |||
| getSouborMetadata | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí metadata jednoho souboru zadaného identifikátorem. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getSouborMetadata |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Oblasti | root |
| Je nutné ověřování | pravděpodobně bez nutnosti přihlášení (služba ovšem na základě konfigurace konkrétní instalace IS/STAG může vyžadovat přihlášení či specifickou roli uživatele) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| soubIdno | long | |||
| getSouborOpravneni | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí informace o oprávněních aktuálního přihlášeného uživatele na zadaný soubor. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getSouborOpravneni |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
ALL
|
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| soubIdno | long | |||
| getSouboryMetadata | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí metadata všech souborů dle zadaných kritérií (tj. například všechny soubory pro zadanou kvalifikační práci atd.). Není-li některý parametr uveden, znamená to, že na něm nezáleží. Zároveň vždy musí být uveden alespoň jeden parametr z množiny, která specifikuje objekt, na který je soubor navázán (tj. např. ID kvalifičkaní práce, ID žádosti atd...) |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getSouboryMetadata |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Oblasti | root |
| Je nutné ověřování | pravděpodobně bez nutnosti přihlášení (služba ovšem na základě konfigurace konkrétní instalace IS/STAG může vyžadovat přihlášení či specifickou roli uživatele) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| tysoIdno | Long | Filtruje požadovaný typ souboru. Je-li prázdné, typ souboru není omezen. | ||
| adipIdno | Long | Identifikátor kvalifikační práce, na kterou je soubor přímo navázán | ||
| stpsIdno | Long | Identifikátor příjezdu, na který je soubor přímo navázán | ||
| stzaIdno | Long | Žádost studenta, na kterou je soubor přímo navázán | ||
| osCislo | String | Osobní číslo studia, na které je soubor přímo navázán | ||
| getTypSouboru | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí požadovaný typ souboru. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getTypSouboru |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Oblasti | root |
| Je nutné ověřování | pravděpodobně bez nutnosti přihlášení (služba ovšem na základě konfigurace konkrétní instalace IS/STAG může vyžadovat přihlášení či specifickou roli uživatele) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| tysoIdno | long | |||
| getTypySouboru | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vrátí seznam všech typů souborů podporovaných v IS/STAG. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/getTypySouboru |
| Možné výstupní MIME typy | application/xml, text/xml, application/json, text/yaml, text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Oblasti | root |
| Je nutné ověřování | pravděpodobně bez nutnosti přihlášení (služba ovšem na základě konfigurace konkrétní instalace IS/STAG může vyžadovat přihlášení či specifickou roli uživatele) |
| updateSouborSetExterniURL | |
|---|---|
| Garance | Garantováno minimálně do 16.4.2025 |
| Komentář | Vymění soubor uložený v databázi IS/STAG (ODSTRANÍ JEJ) za zadané externí URL souboru. Pro role ADMINISTRATOR, KNIHOVNA a KNIHOVNA_SPRAVCE. Služba vrací řetězec OK pokud bylo v pořádku nastaveno, jinak vrací text chyby. Při volání této služby pro soubor nějaké kvalifikační práce se tato práce nepřeplánuje k odeslání do Theses.CZ. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/soubory/updateSouborSetExterniURL |
| Možné výstupní MIME typy | text/plain |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
AD
(Administrátor)
KN (Knihovna) KS (Knihovna správce) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| soubIdno | long | |||
| souborURL | String | Nové URL, které bude uloženo k souboru v IS/STAG | ||