Page tree
Skip to end of metadata
Go to start of metadata

Kuinka REST-lukurajapintaa pääsee käyttämään?

Kukin tiedonkeruuseen osallistuva organisaatio voi hakea REST-rajapinnan kautta, mutta rajapinnan käyttöoikeus on tällöin rajoitettu organisaatiokohtaisesti ja rajauksen toiminta perustuu käyttöoikeutta haettaessa ilmoitettuun IP osoitteeseen. 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

Erikseen sovittuja tarkoituksia varten käyttöoikeutta voidaan laajentaa koskemaan muitakin organisaatioita, mutta tällöin käyttöoikeutta varten täytyy hakea tiedonluovutuslupa kunkin organisaation tietojen osalta. Voimassaolevat tiedonluovutusluvat ovat saatavilla wikisivulla: Tiedonluovutusluvat

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

Lisätietoja ja ohjeita rajapinnan käytöstä saa osoitteesta: virta-julkaisutietopalvelu@csc.fi

Haku

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

JSON-muodossa palautettavat tiedot:

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

Hakuparametrit

NimiPakollisuusLyhyt kuvausVakioarvoSchema
etunimieiOrganisaation tekijän etunimet (vapaatekstihaku)-string
sukunimieiOrganisaation tekijän sukunimi (vapaatekstihaku)-string
henkiloHakueiTekijähaku kaikista tekijäkentistä (vapaatekstihaku)-string
julkaisunNimieiJulkaisun nimi (vapaatekstihaku)-string
lehdenNimieiLehden nimi  (vapaatekstihaku)-string
julkaisuVuosieiJulkaisuvuosi-string
organisaatioTunnuseiOrganisaatiotunnus-string
julkaisunOrgTunnuseiOrganisaation julkaisulle antama yksilöivä tunnus.-string
orcideiORCID -tunniste-string
julkaisuTyyppieiJulkaisun tyyppikoodi-string
julkaisunTilaeiJulkaisun tilakoodi-string
issneiISSN-string
isbneiISBN-string
kustantajanNimieiKustantajan nimi (vapaatekstihaku)-string
doieiDOI-string
muutospvmAlkueiMuutospäivämäärästä lähtien, (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z)-string
muutospvmLoppuei

Muutospäivämäärään asti (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z)

-string
luontipvmAlkueiLuontipäivämäärästä lähtien, (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z)-string
luontipvmLoppueiLuontipäivämäärään asti, (Date ISO-8601 -formaatti, esim. 2016-03-22T07:52:44Z)-string
yhteisJulkaisunTunnuseiUseista organisaatioista raportoitu julkaisu tunnistetaan yhteisjulkaisuksi, jota varten muodostetaan tietovarannossa CSC:llä yhteisjulkaisua varten uusi tietue ja sille tunnus automaattisesti.-string
jufoTunnuseiJulkaisukanavan Jufo-ID-tunniste, joka on  luokituksen mukainen 4/5 -numeroinen arvo, esim. 5003.-string
ilmoitusVuosieiVuosi, jona julkaisu on ilmoitettu ensimmäisen kerran.-string

 

Hakuesimerkkejä

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

Yksittäisen julkaisun tietojen hakeminen

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

 

Hakuesimerkkejä

# 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


Rajoitetun pääsyn rajapinnat

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


Esimerkkivastauksia


Yksittäisen julkaisun tiedot XML-muodossa: 0010696814.xml

Yksittäisen julkaisun tiedot JSON-muodossa:0010696814.json

Hakutulokset JSON-muodossa:haku.json

 

 

 

REST-rajapinnan testiympäristö

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.
Testiympäristössä käyttö on rajattu organisaatiotunnukseen: 99999

Tällä hetkellä saatavilla ovat julkaisut: 02018654YJ, 0036955213, 0037392213, 0039657613, 0039986113