soubory
Description Soubory v IS/STAG
Type REST
Address /ws/services/rest2/soubory
Specifikace REST WADL  Open API  Open API (YAML) 
Title soubory

Operation

getSouborContent
Comment 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 */*
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
stagUser String
soubIdno long

getSouborContentAuth
Comment 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 */*
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles ALL
Arguments
Title Type (Java) Comment
stagUser String
soubIdno long

getSouborContentForThesesCZ
Comment 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 */*
Areas root
Authentication necessary log in, authenticate with special user account
Arguments
Title Type (Java) Comment
soubIdno long

getSouborMetadata
Comment 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
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
soubIdno long

getSouborOpravneni
Comment 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
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles ALL
Arguments
Title Type (Java) Comment
stagUser String
soubIdno long

getSouboryMetadata
Comment 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
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
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
Comment 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
Areas root
Authentication necessary without logging in
Arguments
Title Type (Java) Comment
tysoIdno long

getTypySouboru
Comment 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
Areas root
Authentication necessary without logging in

updateSouborSetExterniURL
Comment 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
Areas root
Authentication necessary log in, authenticate with user role
Permitted roles AD (Administrator)
KN (Library)
KS (Administrator's library)
Arguments
Title Type (Java) Comment
stagUser String
soubIdno long
souborURL String Nové URL, které bude uloženo k souboru v IS/STAG