Index dle názvu

Authentication And Authorization

Od verze v1 (URI: /v1/) a novějších se pro ověření používá pouze CTU OAuth Server.
Jako rozcestník pro přístup pomocí OAuth2 použijte prosím https://rozvoj.fit.cvut.cz

REST DataType Authorship

Identifikátor Český název Datový typ Omezení Popis
personalNumber osobní číslo autora integer
firstName jméno autora string
lastName přijmení autora string
participation podíl integer
type typ účasti string

REST DataType Authorships

Identifikátor Datový typ Popis
authorships List <Authorship> seznam autorů
atribut size počet vrácených výsledků

Citation

Identifikátor Český název Datový typ Omezení Popis

Citations

Identifikátor Datový typ Popis
citations List <Citation> seznam citací
atribut size počet vrácených výsledků

Division

Identifikátor Český název Datový typ Omezení Popis
id kód integer kód organizační jednotky
name jméno string název organizační jednotky
id bude nahrazeno za code

Divisions

Identifikátor Datový typ Popis
divisions List <Division> seznam organizačních jednotek
atribut size počet vrácených výsledků

REST DataType Grant

Identifikátor Český název Datový typ Omezení Popis
id kód integer
name název string Název grantu
annotation anotace string
fromYear od_roku integer Rok, kdy byl grant vyhlášen
toYear do_roku integer Rok, do kdy je grant vyhlášen
number číslo grantu string číslo grantu
id bude nahrazeno za code

Grants

Identifikátor Datový typ Popis
grants List <Grant> seznam grantů
atribut size počet vrácených výsledků

Patent

Identifikátor Český název Datový typ Omezení Popis
id kód integer
language jazyk string
name název string
url url string
year rok integer
releaseDate datum vydání String
biblio biblio string

Patents

Identifikátor Datový typ Popis
patents List <Patent> seznam patentů
atribut size počet vrácených výsledků

DataType People

Identifikátor Datový typ Popis
people List <Person> seznam lidí
atribut size počet vrácených výsledků

DataType Person

Identifikátor Český název Datový typ Omezení Popis
firstName křestní jméno string
lastName přijmení string
fullName celé jméno string celé jméno i s tituly
personalNumber osobní číslo integer
username uživatelské jméno string

Publication

Identifikátor Český název Datový typ Omezení Popis
id kód integer
language jazyk string
name název string
url url string
year rok integer
releaseDate datum vydání String
biblio biblio string
type typ string typ publikace

Publications

Identifikátor Datový typ Popis
publications List <Publication> seznam publikací
atribut size počet vrácených výsledků

PublishedDocument

Identifikátor Český název Datový typ Omezení Popis
id kód integer
language jazyk string
name název string
url url string
year rok integer
releaseDate datum vydání String
biblio biblio string
type typ string typ publikovaného dokumentu

PublishedDocuments

Identifikátor Datový typ Popis
publishedDocuments List <PublishedDocument> seznam publikovaných dokumentů
atribut size počet vrácených výsledků

REST DataType RIV

Identifikátor Český název Datový typ Omezení Popis
divisionId ID katedry integer
points počet bodů string
url odkaz integer
year rok integer

REST DataType RIVs

Identifikátor Datový typ Popis
rivs List <RIV> seznam RIV bodů
atribut size počet vrácených výsledků

Recognition

Identifikátor Český název Datový typ Omezení Popis
id id integer
name název string
fromYear do_roku integer
toYear do_roku integer
type typ string

Recognitions

Identifikátor Datový typ Popis
recognitions List <Recognition> seznam uznání
atribut size počet vrácených výsledků

ResearchPlan

Identifikátor Český název Datový typ Omezení Popis
id kód integer
name název string Název výzkumného záměru.
annotation anotace string
fromYear od_roku integer Rok, kdy byl výzkumný plán vyhlášen.
toYear do_roku integer Rok, do kdy je výzkumný plán vyhlášen.
number číslo grantu string Číslo výzkumného plánu.
id bude nahrazeno za code

REST DataType ResearchPlans

Identifikátor Datový typ Popis
researchPlans List <ResearchPlan> seznam výzkumných plánů
atribut size počet vrácených výsledků

REST Typy akcí

Zde se jedná pouze o granty a výzkumné záměry.

Identifikátor Český název Anglický název
DHC Drobná hospodářská činnost
HSM Hospodářská smlouva
JVZ Jiný veřejný zdroj
NOC Nerutinní odborné činnosti
NVZ Neveřejný zdroj
PRJ Grant, projekt Grant
RVO Institucionální podpora na rozvoj výzkumné org.
SMV Smluvní výzkum
SPZ Spolupráce se zahraničím
SSZ Smlouva o spolupráci se zahraničím
SV Specifický výzkum
VZ Výzkumný záměr
VZS Výzkumný záměr střediska

Typy autorství

Identifikátor Český název Anglický název
01 autor author
04 editor editor
20 školitel supervisor
22 vedoucí dipl. práce supervisor
23 překladatel translator
24 recenzent reviewer
25 oponent reviewer
30 pořadatel organizer
99 et al. et al.

Typy dokumentů

Publikace

Identifikátor Český název Anglický název
ABC Abstrakt v časopisu
ABS Abstrakt ve sborníku Abstract in Proceedings
CAS Časopis Journal
CLA Článek Paper
CLX Článek, který teprve vyjde (je přijatý)
CSC Kandidátská disertační práce (CSc.) PhD Thesis
DIP Diplomová práce Master Thesis
DOC Docentská habilitační práce Associate Professor Thesis
DR Doktorská práce (Dr.) Doctoral Thesis
DRSC Doktorská disertační práce (DrSc.) Doctoral Thesis
ECA Online elektronický časopis Online Journal
ECL Článek v online časopisu Online Paper
EDC Editorství speciálního čísla časopisu
EDL Elektronický dokument s lokálním přístupem (CD)
EDV Elektronický dokument se vzdáleným přístupem (web)
ENC Encyklopedie Encyclopedia
HAB Habilitační přednáška Associate Professor Lecture
KAP Kapitola v knize Chapter in Book
KNI Kniha Book
KNS Kniha - sborník kapitol Book
MIN Doktorandské minimum
NOR Norma Standard
PHD Doktorská práce (Ph.D.) PhD Thesis
PRE Nepublikovaná přednáška Unpublished Lecture
PRK Překlad monografie Translation
RMO Recenze monografie
RZP Výroční zpráva Annual Report
SBO Sborník Proceedings
SLO Slovník Dictionary
SSS Středoškolské skriptum Secondary School Lecture Notes
SSU Středoškolská učebnice Secondary School Textbook
STA Stať ve sborníku Paper in Conference Proceedings
STV Stať ve sborníku vyzvaná či oceněná Invited Paper
TZP Technická zpráva Technical Report
VID Audiovizuální tvorba
VSS Vysokoškolské skriptum University Lecture Notes
VSU Vysokoškolská učebnice University Textbook
VZP Výzkumná zpráva Research Report

Aplikační výsledky

Identifikátor Český název Anglický název
ADI Architektonické dílo
ASA Architektonická soutěž veřejná anonymní
ASK Architektonická soutěž kombinovaná
ASN Architektonická soutěž veřejná neanonymní
ASW Software splňující podmínky RIV (dřív Autorizovaný
ASY Architektonická soutěž vyzvaná
ATD Architektonické a technické dílo
AUD Architektonické a umělecké dílo
AVA Architektonická výstava - salon
AVP Architektonická výstava - přehlídka
AVS Architektonická výstava samostatná
AVV Architektonická výstava skupinová vyzvaná
EXH Pořádání výstavy
FVZ Funkční vzorek
JPR Jiný projekt (SHP, POV apod.)
KNF Pořádání konference
LEP Léčebný postup (do RIV)
MAP Specializovaná mapa s odborným obsahem (do RIV)
MET Jiná metodika (nesplňující podmínky RIV)
MNR Jiná mapa (nesplňující podmínky RIV)
NEP Nepatentovaný vynález (know-how)
ODR Odrůda
OVT Ověřená technologie
OZN Ochranná známka Registered Trademark
OZP Přihláška ochranné známky Registered Trademark Application
PAM Památkový postup (do RIV)
PAP Patentová přihláška Patent Application
PAT Patent Patent
PLE Plemeno
PNR Jiné právní předpisy apod. (nesplňující podm. RIV)
PPN Výsledky promítnuté do právních předpisů a norem
PPR Poloprovoz
PRO Prototyp Prototype
PRP Přihláška průmyslového vzoru Industrial Model Application
PRV Průmyslový vzor Industrial Model
PUR Projekt k územnímu řízení nebo stavebnímu povolení
REP Realizační projekt
SKD Výsl. prom. do schvál. strateg. a koncep. dokum.
SME Výsledky promítnuté do směrnic a nelegisl.předpisů
SOF Jiný software (nesplňující podmínky RIV)
STU Studie (architektonická, urbanistická)
TDI Technické dílo
TOP Topografie polovodičových výrobků
TUD Technické a umělecké dílo
UDI Umělecké dílo
UPM Uplatněná certifikovaná metodika (do RIV)
USA Výtvarná (umělecká) soutěž veřejná anonymní
USN Výtvarná (umělecká) soutěž veřejná neanonymní
USY Výtvarná (umělecká) soutěž vyzvaná
UVA Umělecká výstava - salon
UVS Umělecká výstava samostatná
UVV Umělecká výstava skupinová vyzvaná
UZP Přihláška užitného vzoru Utility Model Application
UZV Užitný vzor Utility Model
WSH Pořádání workshopu

Typy uznání

Identifikátor Český název Anglický název
CSP Člen odborné společnosti Society Member
HOP Hostující profesor
OCE Ocenění v soutěži
OOR Odborný orgán
OVK Organizační výbor konference Conference Organisation Commitee
PVK Programový/ediční výbor konference Conference Programme Commitee
REC Recenze pro časopis
RED Členství v redakční radě časopisu Editorial Board Member
VSP Výbor vědecké společnosti Society Board Member

Ostatní, prozatím nezařazené typy

Identifikátor Český název Anglický název
CAS Časopis Journal
ECA Online elektronický časopis Online Journal
DHC Drobná hospodářská činnost
HSM Hospodářská smlouva
SPZ Spolupráce se zahraničím
SSZ Smlouva o spolupráci se zahraničím
VZ Výzkumný záměr
SV Specifický výzkum
PNR Jiné právní předpisy apod. (nesplňující podm. RIV)
NEP Nepatentovaný vynález (know-how)
NOC Nerutinní odborné činnosti
LEP Léčebný postup (do RIV)
ODR Odrůda
PLE Plemeno
PAM Památkový postup (do RIV)
JVZ Jiný veřejný zdroj
NVZ Neveřejný zdroj
RVO Institucionální podpora na rozvoj výzkumné org.
TOP Topografie polovodičových výrobků
SMV Smluvní výzkum

REST Resources Citations

GET /citations

Vrátí detaily všech evidovaných citací.

GET /citations/{id}

Vrátí detail citace.

REST Resources: Divisions

GET /divisions

Vrátí všechna evidovaná oddělení - pouze katedry

GET /divisons/{divisionCode}

Vrátí katedru.

GET /divisions/{divisionCode}/people

Seznam pracovníků na katedře nebo fakultě.

GET /divisions/{divisionCode}/publishedDocuments

Všechny dokumenty publikované katedrou nebo fakultou. (Publikace, Patenty, ...)

GET /divisions/{divisionCode}/patents

Patenty všech pracovníků katedry nebo fakulty.

GET /divisions/{divisionCode}/publications

Publikace všech pracovníků katedry nebo fakulty.

GET /divisions/{divisionCode}/grants

Granty všech pracovníků katedry nebo fakulty.

GET /divisions/{divisionCode}/researchPlans

Výzkumné plány na katedře nebo fakultě.

GET /divisions/{divisionCode}/researchGroups

Výzkumné skupiny na katedře nebo fakultě.

GET /divisions/{divisionCode}/recognitions

Uznání všech pracovníků katedry nebo fakulty.

REST Resources Grants

GET /grants

Vrátí všechny evidované granty.

GET /grants/{id}

Vrátí určitý grant.

GET /grants/{id}/patents

Patenty vytvořené v rámci tohoto grantu.

GET /grants/{id}/publications

Publikace vytvořené v rámci grantu.

GET /grants/{id}/publishedDocuments

Všechny publikované dokumenty vytvořené v rámci tohoto grantu.

REST Resources Patents

GET /patents

Vrátí všechny evidované patenty.

GET /patents/{id}

Vrátí určitý patent.

GET /patents/{id}/rivs

Vrátí všechny RIV body daného patentu.

GET /patents/{id}/authorships

Vrátí všechny autory daného patentu.

REST Resources: People

GET /people

Vrátí všechny evidované pracovníky.

GET /people/{personalNumber | username}

Vrátí daného pracovníka.

GET /people/{personalNumber | username}/publishedDocuments

Všechny publikované dokumenty daného pracovníka (Publikace, Patenty, ...)

GET /people/{personalNumber | username}/patents

Patenty daného pracovníka.

GET /people/{personalNumber | username}/publications

Publikace daného pracovníka.

GET /people/{personalNumber | username}/grants

Granty které daný pracovník řešil.

GET /people/{personalNumber | username}/researchPlans

Výzkumné plány

GET /people/{personalNumber | username}/researchGroups

Výzkumné skupiny, ve kterých je daný pracovník členem.

GET /people/{personalNumber | username}/recognitions

REST Resources Publications

GET /publications

Všechny evidované publikace.

GET /publications/{id}

Vrátí určitou publikaci.

GET /publications/{id}/rivs

Vrátí všechny RIV body dané publikace.

GET /publications/{id}/authorships

Vrátí všechny autory dané publikace.

REST Resources PublishedDocuments

GET /publishedDocuments

Všechny evidované publikované dokumenty - bez rozdílu: patent vs publikace vs cokoliv.

GET /publishedDocuments/{id}

Vrátí určitý publikovaný dokument.

GET /publishedDocuments/{id}/rivs

Vrátí všechny RIV body daného publikovaného dokumentu.

GET /publishedDocuments/{id}/authorships

Vrátí všechny autory daného publikovaného dokumentu.

REST Resources ResearchGroups - Výzkumné skupiny

Jako identifikátor prozatím “nějaký” code - ještě nevíme jaký identifikátor skupinám přiřadíme.

GET /researchGroups

Vrátí seznam všech evidovaných skupin.

GET /researchGroups/{code}

Vrátí detail výzkumné skupiny.

GET /researchGroups/{code}/people

Vrátí členy výzkumné skupiny.

GET /researchGroups/{code}/grants

Vrátí granty v rámci všech členů výzkumné skupiny.

GET /researchGroups/{code}/patents

Vrátí patenty v rámci všech členů výzkumné skupiny.

GET /researchGroups/{code}/publications

Vrátí publikace v rámci všech členů výzkumné skupiny.

GET /researchGroups/{code}/publishedDocuments

Všechny publikované dokumenty v rámci všech členů výzkumné skupiny.

GET /researchGroups/{code}/researchPlans

Výzkumné plány v rámci všech členů výzkumné skupiny.

RESTful zdroje

RESTful zdroje
Typy obsahu
Výčtové typy
AAA
TODO
Vyhledávání
Vývojový cyklus

TODO

Verze 1.0 bude obsahovat:

Typy obsahu

Vyhledávání

Pro vyhledávání je zde použito jazyka RSQL, který vyvinul Jakub Jirutka. Dokumentaci k RSQL a příklady lze najít na wiki projektu kosapi. Viz, https://kosapi.fit.cvut.cz/projects/kosapi/wiki/Query#RSQL

Vývojový cyklus

VVVSapi je přístupné v několika verzích, vývojová a stabilní.

Vývojová verze se mění, je otevřená novým požadavkům na implementaci a nezaručuji neměnnost resources a datových typů. Stabilní verze je taková, která se vydá pokud nastane potřeba zmrazit vývojovou verzi. Pokud se ve stabilní verzi objeví chyba, její oprava se samozřejmě do stabilní verze začlení.

Co se týká změn ve vývojové verzi, ve většině případů se jedná o přidávání funkčnosti. Nicméně pokud opravdu potřebujete ve své aplikaci používat vývojovou verzi, nabízím v případě změn stávajících resources možnost zaslání emailu s plánem co a jak se bude měnit. Přidám si Vás do skupiny k jednotlivým verzím a budete na kopii emailu který jednou za čas mohu zaslat. Každopádně primární zdroj o změnách v api jsou novinky na této wiki, které jsou dostupné i v Atom formátu a vřele doporučuji novinky sledovat jelikož tam publikuji všechny změny v api. Vaše možnost být na kopii emailu v případě změn ve vývojové verzi je moje osobní a dobrovolná aktivita, proto prosím, aby to bylo bráno v potaz.

Aktuálně se také uvažuje o odstraňování starých/deprecated/oldstable verzí api. Nicméně k tomuto kroku by se přistoupilo pouze pokud by se musel udržovat větší počet verzí v produkci.

Každopádně všechno je o domluvě, proto veškeré dotazy, nalezené chyby a návrhy na vylepšení zasílejte na helpdesk-portal@fit.cvut.cz

Výčtové typy

Hlavní stránka

VVVSapi poskytuje aplikační rozhraní (API) v podobě RESTful webových služeb, které zprostředkovává přístup k vybrané části dat v databázi VVVS. Tato databáze obsahuje všechny informace o výzkumu, vědě a věděckých skupinách na ČVUT.

Přístup k dokumentaci viz pravý panel.

URI:

Dotazy, nalezené chyby a návrhy na vylepšení zasílejte na email: helpdesk-portal@fit.cvut.cz