Yleistä rajapinnasta
Julkisen rajapinnan kautta voi tehdä pyyntöjä mm. kohdistaen ne eri tyyppeihin (mm. hanke, lainsäädäntöhanke, toimielin, strategia) sekä asettaa pyynnöille erilaisia suodatuksia. Hallituksen toimintasuunnitelman rakenne ja keinot ovat myös saatavissa rajapinnan kautta, mukaan lukien niiden liitokset em. kohteisiin.
Tietomalli
Kohde
Kohde on yleisnimitys kehittämishankkeille, lainsäädäntöhankkeille, toimielimille sekä strategioille. Nämä ovat kaikki hyvin samankaltaisia entiteettejä, ja niillä on mm. seuraavat yhteiset tiedot:
- tunnus
- nimi
- asettaja
- kuvaus
- tiivistelmä
- etapit
- suhde hallitusohjelmaan
- jäsenet
- asiakirjat
- budjetti
- linkit
- yms.
Lainsäädäntöhanke poikkeaa muista kohteista hieman enemmän, sillä sen käsittely etenee tarkkaan määritetyn prosessin mukaisesti. Lainsäädäntöhankkeella on siis em. yhteisten tietojen lisäksi käsittelyyn liittyviä tietoja, kuten:
- tieto, onko lainsäädäntöhanke kiireellinen
- tieto, onko lainsäädäntöhanke budjettilaki
- lainsäädäntöhankkeeseen mahdollisesti liittyvät hallituksen esityksen, eduskunnan vastauksen sekä säädöskokoelman numerot
- yms.
Kohteet saattavat kuulua myös hierarkkiseen rakenteeseen, eli ne voivat liittyä toisiinsa. Kullakin kohteella saattaa olla useita alikohteita, mutta vain yksi ylikohde.
Asettaja
Asettaja on jokin ministeriö tai valtioneuvoston kanslia. Kullakin kohteella voi olla vain yksi asettaja, mutta asettajalla saattaa luonnollisesti olla suurikin määrä kohteita.
Henkilö
Kohteilla on jäseninä henkilöitä. Nämä saavat kohteissa erilaisia rooleja, kuten hankepäällikkö, yhteyshenkilö, sihteeri jne. Sama henkilö saattaa kuulua useampaan kohteeseen, ja samoin yhdellä kohteella voi luonnollisesti olla jäsenenä useita henkilöitä. Sama henkilö saattaa toimia kohteessa myös useammassa roolissa.
Hallitusohjelman toimintasuunnitelma
Hallitusohjelman toimintasuunnitelma on rakenne, joka koostuu elementeistä ja välitavoitteista. Elementit muodostavat hierarkkisen rakenteen, jossa elementillä voi olla useita alielementtejä mutta vain yksi ylielementti. Elementillä on tyyppi, joka kuvastaa tarkemmin mikä elementin tarkoitus on. Elementillä voi olla useita välitavoitteita. Välitavoitteella on myös tyyppi sekä tavoiteaikataulu, jolloin se pitäisi olla valmis.
Välitavoitteilla saattaa olla liitoksia kohteisiin, jolloin ne nähdään osana hallitusohjelman toimintasuunnitelmaa. Liitosta voidaan vastaavasti tarkastella myös siltä kannalta, että yhtä välitavoitetta toteuttaa useampi kohde.
Sipilän hallituksella oli käytössä vanhempi tietorakenne. Se koostuu painopistealueista, kärkihankkeista sekä toimenpiteistä. Ylin taso on painopistealueet. Näihin kuuluu useita kärkihankkeita, joihin kuhunkin puolestaan kuuluu useita toimenpiteitä.
Rajapinnan kokeileminen Swagger UI -dokumentaatiosivulta
Rajapintametodien dokumentaatio on generoitu Swagger:lla. Tästä voit ladata käyttöohjeen rajapinnan kokeilemiseen Swagger UI -dokumentaatiosivulta käsin.