Kansalliskirjastossa on kehitetty oma REST-rajapinta (SimpleREST), jolla pääsee käsiksi ja muokkaamaan kaikkia Dspacen resursseja, kuten kokoelmia, tietueita ja käyttäjiä. Rajapinta tukee myös Dspacen omaa autentikointia. SimpleRestistä ei ole julkista dokumentaatiota saatavilla, mutta asiakaskohtaisesti voidaan neuvotella SimpleRestin käytöstä, jos se katsotaan tarpeelliseksi. Lähinnä käyttö koskee tällöin tietueiden syöttöä sekä niiden päivittämistä.

Muutama vuosi SimpleRestin valmistumisen jälkeen Dspaceen on toteutettu myös sen oma, virallinen REST-rajapinta. Rajapinnasta puuttui aluksi tietojen syöttö- ja päivitystoiminnot, mutta ne on jälkeenpäin toteutettu, ja rajapinta on toiminnoiltaan nyt hyvällä tasolla. Kun rajapinnasta saadaan enemmän kokemuksia maailmalla ja se on osoittautunut ongelmattomaksi, alamme suosittelemaan sen käyttöä asiakkaillemme. Toistaiseksi käytämme kuitenkin SimpleRestiä, jossa on ollut syöttö- ja päivitystoiminnot käytössä useamman vuoden ja joka on todettu vakaaksi ja toimivaksi.  

 

DSpace 5.6 REST

Viralliset ohjeet löytyvät täältä. Alle päivitetään käytännön esimerkkejä.

 

DSpace Rest Tokenin Hakeminen

  • Pyyntö osoitteeseen POST /rest/login, json payload:

    {"email": "email@email.com", "password": "1234"}

    Esimerkkivastaus:

    8a5bd933-e679-4ad3-8b5a-dd2a77941bff

    Vastauksena saatu token pitää sisällyttää rest-dspace-token headeriin, kun tekee lisäys-/poisto-/muokkausoperaatioita.

Itemin lisääminen (embargolla tai ilman)

  • Luo item: (rest osoite:  POST /rest/collections/1/items) headerit: 

    rest-dspace-token: 8a5bd933-e679-4ad3-8b5a-dd2a77941bff
    Accept: application/json

    json payload: 

    {"name": "EmbargoTesti", "metadata": [
    	{"key": "dc.title", "value": "EmbargoTesti"},
    	{"key": "dc.embargo.terms", "value": "2017-10-19"}
    ]}
    
    

    Esimerkkivastaus: 

    {
    	"id": 224,
    	"name": "EmbargoTesti",
    	"handle": null,
    	"type": "item",
    	"link": "/rest/items/224",
    	"expand": [ "metadata", "parentCollection", "parentCollectionList", "parentCommunityList", "bitstreams", "all" ],
    	"lastModified": "2017-10-18 14:52:17.299",
    	"parentCollection": null,
    	"parentCollectionList": null,
    	"parentCommunityList": null,
    	"bitstreams": null,
    	"archived": "false",
    	"withdrawn": "false"
    }
  • Luo bitstream: (rest osoite POST /rest/items/{itemId}/bitstreams?name=my_testi4.pdf&description=testitiedosto, jos haluat embargon, niin POST /rest/items/{itemId}/bitstreams?name=my_testi4.pdf&description=testitiedosto&groupId=0&year=2017&month=10&day=19) itemId saadaan edellisen pyynnön json vastauksesta. Tiedosto lähetetään form-datana.
    Esimerkkivastaus:

    { 
    	"id": 76,
    	"name": "my_testi4.pdf", 
    	"handle": null,
    	"type": "bitstream",
    	"link": "/rest/bitstreams/76",
    	"expand": [ "parent", "policies", "all" ],
    	"bundleName": "ORIGINAL",
    	"description": "testitiedosto",
    	"format": "Adobe PDF",
    	"mimeType": "application/pdf",
    	"sizeBytes": 741609,
    	"parentObject": null,
    	"retrieveLink": "/bitstreams/76/retrieve",
    	"checkSum": {
    		"value": "b2a29cd63a82bc03583d2562b0ac4b3c",
    		"checkSumAlgorithm": "MD5"
    	},
    	"sequenceId": -1,
    	"policies": null
    }
  • Nyt Item on luotu ja bitstream on lisätty.

Itemin metadatan päivittäminen

  • Päivitä item: (rest osoite PUT /rest/items/{item_id}/metadata)
  • headerit:

    rest-dspace-token: 8a5bd933-e679-4ad3-8b5a-dd2a77941bff
    Accept: application/json
  • json payload:

    [{
        "key": "dc.title",
        "value": "New Title",
        "language": "en"
    }]
  • No labels