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), kommentaaride (Comments) ning andmeobjektide (Data Objects) kohta.

RIHA API aadress on https://www.riha.ee/api/v1 API on kirjeldatud Swagger OpenAPI v3.0.1 vormingus, kirjelduse asukoht on https://www.riha.ee/api-docs. Abiks võib olla ka RIHA andmete JSON-skeem.

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).

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://www.riha.ee/api/v1/systems/riha

Konkreetse infosüsteemi kohta avatud arutelude (Issues) nimekirja saab kätte näiteks päringuga https://www.riha.ee/api/v1/systems/riha/issues

Konkreetse arutelu sees sisalduvad kommentaarid saab kätte päringutega https://www.riha.ee/api/v1/issues/17533 ja https://www.riha.ee/api/v1/issues/17533/comments (eeldab RIHA-sse sisselogimist kirjeldaja või hindaja õigustes).

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

Näide andmeobjektide päringu kohta: https://www.riha.ee/api/v1/systems/data-objects?filter=searchName,ilike,%25riha%25&size=600&sort=dataObjectName

Selle päringu tulemusena kuvatakse infosüsteemi lühinimega „riha“ andmeobjektid, järjestatuna andmeobjekti nime alusel kasvavas järjestuses.