...
| Code Block |
|---|
curl -X POST "https://tietomallit.test.yti.cloud.vrk.fi/datamodel-api/api/v1/integration/resources" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"status\":[\"DRAFT\",\"VALID\"],\"after\":\"2018-11-19T14:05:19.451Z\",\"before\":\"2019-01-19T14:05:19.451Z\"}" -H "Authorization: Bearer INSERT_TOKEN_HERE" |
Aineiston hakeminen ja filtteröinti
Aineistoja voidaan hakea /containers ja /resources api:ssa searchTerm parametrin avulla. Vakiona rajapinta palauttaa korkeintaan 50 000 objektia. Sivutusta voidaan säätää pageSize ja from parametrien avulla.
Haettuja aineistoja voidaan myös suodattaa tilan eli status parametrin avulla, määrittelemällä yksi tai useampi tilakoodi. Vakiona palautetaan kaikki muut paitsi keskeneräiset aineistot. Keskeneräiset voidaan palauttaa helposti includeIncomplete parametrin avulla.
Tilakoodit:
| Tilakoodi | Nimi | Tilan tarkoitus |
|---|---|---|
| INCOMPLETE | Keskeneräinen | Keskeneräinen ja kirjautumattomilta piilotettu resurssi jota ei vielä kannata käyttää |
| DRAFT | Luonnos | Julkinen luonnos jota voidaan käyttää. Luonnos on kuitenkin keskeneräinen tuotos joka voidaan poistaa tai korvata toisella. |
| VALID | Voimassa oleva | Organisaation hyväksymä resurssi jota voi käyttää |
| SUPERSEDED | Korvattu | Korvattu resurssi jota ei kannata käyttää |
| RETIRED | Poistettu käytöstä | Poistettu resurssi jota ei kannata käyttää |
| INVALID | Virheellinen | Virheellinen resurssi jota ei kannata käyttää |
| SUGGESTED | Ehdotus | Sanastoon käyttäjän toimesta ehdotettu käsite. Käytössä vain sanastoissa! Keskeneräinen tuotos joka voidaan poistaa tai korvata toisella. |
Aineiston resolvointi uri:n avulla
Harmonisoidut integration-rajapinnat tarjoavat yksinkertaisen tavan listata aineistot. Listauksen perusteella voidaan hakea tarkempia julkaisukohtaisia tietoja resolvoimalla aineisto URI-tunnuksen avulla.
...