to.science.api

https://github.com/hbz/to.science.api/blob/master/conf/routes

Create

Create a new resource

curl -i -u$API_USER:$PASSWORD -XPUT $REGAL_API/resource/regal:1234 -d'{"contentType":"monograph","accessScheme":"public"}' -H'content-type:application/json'

Create a new hierarchy

curl -i -u$API_USER:$PASSWORD -XPUT $REGAL_API/resource/regal:1235 -d'{"parentPid":"regal:1234","contentType":"file","accessScheme":"public"}' -H'content-type:application/json'

Upload binary data

curl -u$API_USER:$PASSWORD -F"data=@$ARCHIVE_HOME/src/REGAL_API/test/resources/test.pdf;type=application/pdf" -XPUT $REGAL_API/resource/regal:1235/data

Create User

See Sichtbarkeiten, Operationen, Rollen for available roles.

curl -u$API_USER:$PASSWORD -d'{"username":"test","password":"test","email":"test@example.org","role":"EDITOR"}' -XPUT $REGAL_API/utils/addUser -H'content-type:application/json'

Upload metadata

curl -XPUT -u$API_USER:$PASSWORD -d'<regal:1234> <dc:title> "Ein Test Titel" .' -H"content-type:text/plain" $REGAL_API/resource/regal:1235/metadata2

Order Child Nodes

$ curl -XPUT -u$API_USER:$PASSWORD -d'["regal:2","regal:1249"]' $REGAL_API/resource/regal:1/parts -H"Content-Type:application/json"

Ingest unmanaged content

Example address for external stored content, i.e. research data: https://api.example.com/data/regal:1234/first_set/data.csv

The base url and the default collection url are configured in the application.conf.

Currently only one level of subpaths is supported.

URL parameter
parameter	default	description
collectionUrl	data	Path to the storage folder
subPath	-	optional: path of the subfolder, ‘first_set’ in above example
filename	-	bare filename, but with extension
resourcePid	<empty>	automatically assigned pid of the external resource

$ curl -XPOST -u$API_USER:$PASSWORD "$REGAL_API/resource/regal:1234/postResearchData?collectionUrl=data&subPath=$dataDir&filename=$dateiname&resourcePid=$resourcePid" -H "UserId=resourceposter" -H "Content-Type: text/plain; charset=utf-8";

Read

Read resource

html

curl $REGAL_API/resource/regal:1234.html

json

curl $REGAL_API/resource/regal:1234.json
curl $REGAL_API/resource/regal:1234.json2

rdf

curl $REGAL_API/resource/regal:1234.rdf

mets

curl $REGAL_API/resource/regal:1234.mets

aleph

curl $REGAL_API/resource/regal:1234.aleph

epicur

curl $REGAL_API/resource/regal:1234.epicur

datacite

curl $REGAL_API/resource/regal:1234.datacite

csv

curl $REGAL_API/resource/regal:1234.csv

wgl

curl $REGAL_API/resource/regal:1234.wgl

oaidc

curl $REGAL_API/resource/regal:1234.oaidc

Read resource tree

curl $REGAL_API/resource/regal:1234/all

curl $REGAL_API/resource/regal:1234/parts

Read binary data

curl $REGAL_API/resource/regal:1234/data

Read Webgatherer Conf

curl $REGAL_API/resource/regal:1234/conf

Read Ordering of Childs

curl $REGAL_API/resource/regal:1234/seq

Read user

not implemented

Read Adhoc Linked Data

curl $REGAL_API/adhoc/uri/$(echo test |base64)

Update

Update Resource

Update Metadata

curl -s -u$API_USER:$REGAL_PASSWORD -XPOST $REGAL_API/utils/updateMetadata/regal:1234 -H"accept: application/json"

Add URN

POST /utils/lobidify

POST /utils/addUrn

POST /utils/replaceUrn

Enrich

POST /resource/:pid/metadata/enrich

Delete

Delete resource

curl -u$API_USER:$REGAL_PASSWORD -XDELETE "$REGAL_API/resource/regal:1234";echo

Purge resource

curl -u$API_USER:$REGAL_PASSWORD -XDELETE "$REGAL_API/resource/regal:1234?purge=true";echo

Delete part of resource

curl -u$API_USER:$REGAL_PASSWORD -XDELETE $REGAL_API/resource/regal:1234/seq

curl -u$API_USER:$REGAL_PASSWORD -XDELETE $REGAL_API/resource/regal:1234/metadata

curl -u$API_USER:$REGAL_PASSWORD -XDELETE $REGAL_API/resource/regal:1234/metadata2

curl -u$API_USER:$REGAL_PASSWORD -XDELETE $REGAL_API/resource/regal:1234/data

curl -u$API_USER:$REGAL_PASSWORD -XDELETE $REGAL_API/resource/regal:1234/dc

Delete user

not implemented

Search

Simple Search

GET /find

GET /resource

Facetted Search

Search for field

Misc

Load metadata from Lobid

curl -u$API_USER:$PASSWORD -XPOST "$REGAL_API/utils/lobidify/regal:1234?alephid=HT018920238"

Reread Labels from etikett

curl -u$API_USER:$PASSWORD -XPOST $REGAL_API/context.json

Reindex resource

curl -u$API_USER:$PASSWORD -XPOST $REGAL_API/utils/index/regal:1234 -H"accept: application/json"