2.2.2. Infosüsteemide kataloogi kasutamine RIHA masinliidese REST API kaudu

RIHA kataloogi poole pöördumiseks on võimalik kasutada ka masinliidest, mille abil on võimalik RIHA-s olevaid andmeid töödelda, siduda muude andmetega, luua lisaväärtust andvaid rakendusi jms.

Masinliidese kaudu saab pärida infosüsteemide kirjeldusi, samuti andmeid arutelude (Issues) ja kommentaaride (Comments) kohta.

RIHA API aadress on https://www.riha.ee/api/v1.

Järgnevalt on toodud mõned näited päringutest, mida saab proovimiseks sisestada otse veebilehitseja aadressiribale.

 

Kõigi infosüsteemide nimekirja saamiseks kasutage päringut

https://www.riha.ee/api/v1/systems

Tulemusena kuvatakse infosüsteemide nimekiri koos lühiandmetega masinloetaval kujul (JSON vormingus).

JSON väljund

JSON väljund

Kuna infosüsteeme on palju, väljastatakse andmed lehekülgede kaupa. Päringu vastus algab infosüsteemide arvuga "totalElements":1708, sellele järgneb element "content" infosüsteemide kirjeldustega. Vastuse lõpus on lehekülje number, lehekülgede arv ja lehekülje suurus (ehk korraga kuvatud infosüsteemide arv): "page":0,"totalPages":84,"size":20.

Lehekülje suurust ja hetkel kuvatavat lehekülge saab päringus seadistada. Näiteks päring

https://www.riha.ee/api/v1/systems?size=50&page=2

seab korraga väljastatavaks infosüsteemide arvuks 50 ja kuvatakse teine lehekülg.


Infosüsteemi detailse kirjelduse saamiseks tuleb päringule lisada infosüsteemi lühinimi, näiteks:

https://koolitus.riha.ee/api/v1/systems/riha-test


Konkreetse infosüsteemi kohta avatud arutelude (Issues) nimekirja saab kätte päringuga

https://koolitus.riha.ee/api/v1/systems/riha-test/issues
JSON väljund


Ja konkreetse arutelu sees sisalduvad kommentaarid saab kätte päringutega (eeldab sisselogimist kirjeldaja või hindaja õigustes)

https://koolitus.riha.ee/api/v1/issues/10857

ja

https://koolitus.riha.ee/api/v1/issues/10857/comments
JSON väljund


Järgnev päring illustreerib filtri, kuvatavate väljade loetelu ning sorteerimiskriteeriumi kasutamist, kuvades staatusega kasutusel infosüsteemide omaniku andmed, infosüsteemi nime ja metaandmed, sorteerituna omaniku nime järgi:

https://www.riha.ee/api/v1/systems?filter=meta.system_status.status,jilike,IN_USE&fields=owner,name,meta&size=2000&sort=owner.name
JSON väljund


Ja veel üks näide:

https://www.riha.ee/api/v1/systems?filter=owner.name,jilike,%25Riigi%20Infosüsteemi%20Amet%25,meta.system_status.status,jilike,IN_USE,topics,jilike,%25Infoühiskond%25&fields=owner,name,topics,contacts&sort=name&size=50


Kuvatakse nende infosüsteemide omanik, nimi, märksõnad ja kontaktid, kus omaniku nimeks on Riigi Infosüsteemi Amet, süsteemi staatuseks on kasutusel ning märksõnade loetelu sisaldab märksõna Infoühiskond. Väljund on sorteeritud infosüsteemi nime järgi ning tulemused väljastatakse 50 kirje kaupa.


Viimati muudetud: kolmapäev, 21. veebruar 2018, 21.56