Virta-julkaisutietopalvelun oman REST-lukurajapinnan ylläpito lopetetaan vuoden 2024 loppuun mennessä. Julkaisutietoja saa jatkossa haettua tutkimustietovarannon lukurajapinnan kautta, ks. https://wiki.eduuni.fi/x/PA6XE. |
Kukin tiedonkeruuseen osallistuva organisaatio voi hakea tietoja Virta-julkaisutietopalvelun REST-rajapinnan kautta. Rajapintaa pääsee käyttämään ilmoittamalla teknisen yhteyshenkilön yhteystiedot (nimi, organisaatio, sähköposti ja puhelin) ja IP-osoitteen, josta rajapintaa haluaa käyttää sähköpostiosoitteeseen virta-julkaisutietopalvelu@csc.fi
Muut kuin tiedonkeruuseen osallistuvat organisaatiot voivat hakea tietoja tutkimustietovarannon erillislaissa (1238/2021) kuvatun mukaisesti.
Ennen tutkimustietovarannon erillislain voimaantuloa rajapinnan käyttöoikeutta oli laajennettu koskemaan muita kuin tiedonkeruuseen osallistuvia organisaatioita erikseen sovittuja tarkoituksia varten erillisillä tiedonluovutustoimeksiannoilla. Voimassaolevat tiedonluovutustoimeksiannot ovat nähtävillä wikisivulla: Tiedonluovutustoimeksiannot
Rajapinta tarjoaa työkalut julkaisujen etsimiseen eri hakukriteerien perusteella, sekä yksittäisen että useamman julkaisun hakemiseen. Julkaisut ovat saatavilla sekä JSON- että XML-muodossa (Julkaisu-XML).
Huomaathan että tietoja lukevan organisaation käyttämän Curl:in versio vaikuttaa sille annettujen parametrien toimintaan.
Lisätietoja ja ohjeita rajapinnan käytöstä saa osoitteesta: virta-julkaisutietopalvelu@csc.fi
/julkaisut/haku
/julkaisu/haku/xml
Hakutulokset palauttavat JSON-muodossa suppeamman tietojoukon, jossa on vain osa julkaisujen perustiedoista. Hakutulokset saa myös XML-muodossa, jolloin palautuvat kaikki tiedot. Katso hakuesimerkit ohjeen loppupuolelta.
"julkaisunTunnus" ,"julkaisunNimi","tekijat","julkaisuVuosi","julkaisuTyyppi","lehdenNimi","issn","muutospvm","luontipvm","julkaisunTila,"julkaisunOrgTunnus", "jufoTunnus", "organisaatioTunnus" ja "ilmoitusVuosi"
XML-muodossa palautettavat tiedot:
Katso Julkaisut-XML skeeman määrittelytiedot ja kuvaukset.
Nimi | Pakollisuus | Lyhyt kuvaus | Vakioarvo | Schema |
---|---|---|---|---|
etunimi | ei | Organisaation tekijän etunimet (vapaatekstihaku) | - | string |
sukunimi | ei | Organisaation tekijän sukunimi (vapaatekstihaku) | - | string |
henkiloHaku | ei | Tekijähaku kaikista tekijäkentistä (vapaatekstihaku) | - | string |
julkaisunNimi | ei | Julkaisun nimi (vapaatekstihaku) | - | string |
lehdenNimi | ei | Lehden nimi (vapaatekstihaku) | - | string |
julkaisuVuosi | ei | Julkaisuvuosi | - | string |
organisaatioTunnus | ei | Organisaatiotunnus | - | string |
julkaisunOrgTunnus | ei | Organisaation julkaisulle antama yksilöivä tunnus. | - | string |
orcid | ei | ORCID -tunniste | - | string |
julkaisuTyyppi | ei | Julkaisun tyyppikoodi | - | string |
julkaisunTila | ei | Julkaisun tilakoodi | - | string |
issn | ei | ISSN | - | string |
isbn | ei | ISBN | - | string |
kustantajanNimi | ei | Kustantajan nimi (vapaatekstihaku) | - | string |
doi | ei | DOI | - | string |
muutospvmAlku | ei | Muutospäivämäärästä lähtien, (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z) | - | string |
muutospvmLoppu | ei | Muutospäivämäärään asti (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z) | - | string |
luontipvmAlku | ei | Luontipäivämäärästä lähtien, (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z) | - | string |
luontipvmLoppu | ei | Luontipäivämäärään asti, (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z) | - | string |
yhteisJulkaisunTunnus | ei | Useista organisaatioista raportoitu julkaisu tunnistetaan yhteisjulkaisuksi, jota varten muodostetaan tietovarannossa CSC:llä yhteisjulkaisua varten uusi tietue ja sille tunnus automaattisesti. | - | string |
jufoTunnus | ei | Julkaisukanavan Jufo-ID-tunniste, joka on luokituksen mukainen 4/5 -numeroinen arvo, esim. 5003. | - | string |
ilmoitusVuosi | ei | Vuosi, jona julkaisu on ilmoitettu ensimmäisen kerran. | - | string |
Useamman julkaisun tieojen hakeminen. Haetaan lehden nimen ja organisaatiotunnuksen mukaan (XML ja JSON (julkaisusjen perustiedot)).
Esimerkissä lehtenä on Suomen lääkärilehti nimi URL enkoodattuna.
# curl -k -i -H "Accept: application/xml" https://virta-jtp.csc.fi/api/julkaisut/haku/xml?lehdenNimi=Suomen%20L%C3%A4%C3%A4k%C3%A4rilehti&organisaatioTunnus=01901
# curl -k -i -H "Accept: application/json" https://virta-jtp.csc.fi/api/julkaisut/haku?lehdenNimi=Suomen%20L%C3%A4%C3%A4k%C3%A4rilehti&organisaatioTunnus=01901
Haettavien julkaisujen rajaaminen julkaisutyypin perusteella. Muut hakuehdot: Lehti: ”Suomen Lääkärilehti” ja Organisaatio on 01901
# curl -k -i -H "Accept: application/json" https://virta-jtp.csc.fi/api/julkaisut/haku?lehdenNimi=Suomen%20L%C3%A4%C3%A4k%C3%A4rilehti&julkaisuTyyppi=A1
# curl -k -i -H "Accept: application/json" https://virta-jtp.csc.fi/api/julkaisut/haku?julkaisuVuosi=2014&organisaatioTunnus=01901
/julkaisut
/julkaisut/xml
Yksittäisen julkaisun hakeminen rajapinnasta XML ja JSON muodossa tapahtuu JulkaisunTunnus arvon perusteella. Kyseessä on Julkaisun yksiselitteisesti identifioiva koodi. Samalla julkaisulla ei voi olla olemassa useampaa julkaisuntunnusta. Julkaisuntunnuksia voi etsiä yllä olevan hakutoiminnallisuuden perusteella.
# curl -k -i -H "Accept: application/xml" https://virta-jtp.csc.fi/api/julkaisut/xml/000051414
# curl -k -i -H "Accept: application/json" https://virta-jtp.csc.fi/api/julkaisut/000051414
Julkaisutiedonkeruun rajapinta sisältää myös muita rajapintoja mutta ne on tarkoitettu vain nimettyä käyttötarkoitusta varten ja niihin pääsyä on rajoitettu. Kyseiset rajapinnat sisältävät toiminnallisuuksia esimerkiksi tietojen syöttämistä varten tai sisältävät historiatietoa esimerkiksi tilastollisia tarkoituksia varten.
Näitä rajapintoja ovat mm:
/julkaisut/{julkaisunTunnus}/hanke
/julkaisut/{julkaisunTunnus}/juuli
/TKjulkaisut
Yksittäisen julkaisun tiedot XML-muodossa: 0010696814.xml
Yksittäisen julkaisun tiedot JSON-muodossa:0010696814.json
Hakutulokset JSON-muodossa:haku.json
Julkaisutietopalvelun rajapinnan testiympäristö löytyy osoitteesta: https://dwitjutife1.csc.fi/api-doc/api-doc.html Alla lueteltuja rajapintoja voi testata vaihtamalla tuotantopalvelimen nimi virta-jtp.csc.fi testipalvelun nimeen dwitjutife1.csc.fi. |