| plagiaty | |
|---|---|
| Popis | API pro napojení anti-plagiátorských systémů pro kontrolu VŠKP a semestrálních prací. |
| Typ | REST |
| Adresa | /ws/services/rest2/plagiaty |
| Specifikace | |
| Název | plagiaty |
Operace
| fileByUid | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Vrátí soubor podle zadaného unikátního UID souboru (podporuje soubory přiložené k VŠKP i k semestrálním pracím). |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/plagiaty/fileByUid/{uid} |
| Možné výstupní MIME typy | */* |
| 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ář | ||
| arg0 | String | |||
| info | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Vrátí detailní údaje o zadaném dokumentu, jeho autorovi, katedře, fakultě, instituci - vše, co se zdá být relevantní ke kontrole plagiátů. Potřebujete-li pro vlastní implementaci nějaké další údaje, kontaktujte vývojový tým IS/STAG. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/plagiaty/info |
| Možné výstupní MIME typy | application/json |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
PR
(Prorektor)
AD (Administrátor) PG (Anti-plagiátorská kontrola) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| typDokumentu | String | 'vskp' pro VŠKP nebo 'sp' pro semestrální práci | ||
| id | long | Podle zadaného typu: ID VŠKP práce nebo ID semestrální práce | ||
| vracetPlagiatResult | Boolean | true/false, zda vracet i polozku plagiatResult (muze byt hodne dlouha a je zbytecne ji posilat kdyz ji klient nepotrebuje). Defaultne false. | ||
| nastavKontrolaNaplanovana | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Uloží do IS/STAG stav dokumentu 'naplánovaná kontrola' - slouží jako možnost vrátit stav do výchozího stavu |
| HTTP metoda | POST |
| Adresa | /ws/services/rest2/plagiaty/nastavKontrolaNaplanovana |
| Možné vstupní MIME typy | application/json |
| Možné výstupní MIME typy | application/json |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
PR
(Prorektor)
AD (Administrátor) PG (Anti-plagiátorská kontrola) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| typDokumentu | String | Typ dokumentu - hodnota 'vskp' - VŠKP nebo 'sp' - semestrální práce. | ||
| id | long | Identifikátor dokumentu | ||
| nastavOdeslanoKeKontrole | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Uloží do IS/STAG stav dokumentu 'odesláno ke kontrole'. Je třeba uložit i položku plagitSystem - do kterého systému byl dokument odeslán. |
| HTTP metoda | POST |
| Adresa | /ws/services/rest2/plagiaty/nastavOdeslanoKeKontrole |
| Možné vstupní MIME typy | application/json |
| Možné výstupní MIME typy | application/json |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
PR
(Prorektor)
AD (Administrátor) PG (Anti-plagiátorská kontrola) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| typDokumentu | String | Typ dokumentu - hodnota 'vskp' - VŠKP nebo 'sp' - semestrální práce. | ||
| id | long | Identifikátor dokumentu | ||
| plagiatSystem | String | Jaký systém kontroly plagiátů byl použit - z domény PLAGIAT_SYSTEM. | ||
| nastavVysledekKontroly | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Uloží do IS/STAG výsledek anti-plagiátorské kontroly u zadaného dokumentu (buď VŠKP - adipIdno a nebo semestrální práce - praceIdno). |
| HTTP metoda | POST |
| Adresa | /ws/services/rest2/plagiaty/nastavVysledekKontroly |
| Možné vstupní MIME typy | application/json |
| Možné výstupní MIME typy | application/json |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
PR
(Prorektor)
AD (Administrátor) PG (Anti-plagiátorská kontrola) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| arg1 | DocumentPlagiatResult | |||
| seznamCekajiciNaVysledek | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Vrátí seznam dokumentů v IS/STAG, které jsou ve stavu, kdy probíhá kontrola a dokumenty čekají na výsledek kontroly plagiátů. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/plagiaty/seznamCekajiciNaVysledek |
| Možné výstupní MIME typy | application/json |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
PR
(Prorektor)
AD (Administrátor) PG (Anti-plagiátorská kontrola) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| typDokumentu | String | Je-li uvedeno, lze omezit na typ dokumentu. Hodnota 'vskp' - pouze VŠKP. 'sp' - pouze semestrální práce. 'all' nebo neuvedeno - všechny | ||
| plagiatSystem | String | Je-li uvedeno, lze omezit na dokumenty, u nichž je nastaven zadaný systém kontroly plagiátů | ||
| seznamKeKontrole | |
|---|---|
| Garance | Garantováno minimálně do 27.4.2025 |
| Komentář | Vrátí seznam dokumentů v IS/STAG, které jsou připraveny k odeslání ke kontrole plagiátů. |
| HTTP metoda | GET |
| Adresa | /ws/services/rest2/plagiaty/seznamKeKontrole |
| Možné výstupní MIME typy | application/json |
| Oblasti | root |
| Je nutné ověřování | přihlášení, ověření dle uživatelské role |
| Povolené role |
PR
(Prorektor)
AD (Administrátor) PG (Anti-plagiátorská kontrola) |
| Parametry | ||||
|---|---|---|---|---|
| Název | Typ (Java) | Komentář | ||
| stagUser | String | |||
| typDokumentu | String | Je-li uvedeno, lze omezit na typ dokumentu. Hodnota 'vskp' - pouze VŠKP. 'sp' - pouze semestrální práce. 'all' nebo neuvedeno - všechny | ||