Use InvenioRDM¶
Use the specified host and port
Due to CSP, it is important that you use the host and port specified when
running the API calls. This means localhost and 127.0.0.1 are not
interchangable as they usually are. The default is 127.0.0.1:5000 for the
development installation and 127.0.0.1 for the containerized installation. Here we
show examples with the development installation.
Use your browser¶
Navigate to https://127.0.0.1:5000. Note that you might need to accept the SSL exception since it's using a test certificate. Below, we list a small subset of the common API calls. For more, see the API reference section.
List records¶
Let's see what is in the instance by querying the API. Using another terminal:
curl -k -XGET https://127.0.0.1:5000/api/records | python3 -m json.tool
{
"aggregations": {
"access_right": {
"doc_count_error_upper_bound": 0,
"sum_other_doc_count": 0,
"buckets": [
{
"key": "open",
"doc_count": 100
}
]
}
},
...
"hits": {
"hits": [
{
"access": {
"files": "restricted",
"embargo": {
"reason": "top secret material",
"until": "2021-08-09",
"active": true
},
"record": "public",
"owned_by": [
{
"user": 1
}
]
},
"id": "mrewd-axc44",
"metadata": {
"sizes": [
"11 pages"
],
"references": [
{
"identifier": "0000000114559647",
"scheme": "isni",
"reference": "Reference to something et al."
}
],
"additional_descriptions": [
{
"lang": "eng",
"description": "The ten free worry lose receive. Feeling church know anyone significant. Public note part style want discussion.",
"type": "methods"
},
{
"lang": "eng",
"description": "Make voice store worry artist real. Ever movement policy born.\nAlmost trial new if. Keep someone keep light heavy indicate.\nSon improve both. Budget home mean evidence crime by.",
"type": "methods"
}
],
"funding": [
{
"funder": {
"identifier": "03yrm5c26",
"scheme": "ror",
"name": "European Commission"
},
"award": {
"identifier": "0000-0002-1825-0097",
"scheme": "orcid",
"number": "246686",
"title": "OpenAIRE"
}
}
],
"formats": [
"application/pdf"
],
"creators": [
{
"person_or_org": {
"type": "personal",
"identifiers": [
{
"identifier": "0000-0002-1825-0097",
"scheme": "orcid"
}
],
"family_name": "Mercado",
"given_name": "Jessica",
"name": "Mercado, Jessica"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Harris-Grimes"
}
]
},
{
"person_or_org": {
"type": "personal",
"identifiers": [
{
"identifier": "0000-0002-1825-0097",
"scheme": "orcid"
}
],
"family_name": "Arnold",
"given_name": "Rebecca",
"name": "Arnold, Rebecca"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Miller-Smith"
}
]
},
{
"person_or_org": {
"type": "personal",
"identifiers": [
{
"identifier": "0000-0002-1825-0097",
"scheme": "orcid"
}
],
"family_name": "Lara",
"given_name": "Sherri",
"name": "Lara, Sherri"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Jensen-Dunn"
}
]
},
{
"person_or_org": {
"type": "personal",
"identifiers": [
{
"identifier": "0000-0002-1825-0097",
"scheme": "orcid"
}
],
"family_name": "Garcia",
"given_name": "Steven",
"name": "Garcia, Steven"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Hernandez Group"
}
]
}
],
"resource_type": {
"id": "publication"
},
"publication_date": "1971-12/1973-06-22",
"publisher": "InvenioRDM",
"additional_titles": [
{
"lang": "eng",
"type": "subtitle",
"title": "a research data management platform"
},
{
"lang": "eng",
"type": "alternativetitle",
"title": "Anderson and Sons's gallery"
}
],
"version": "v0.0.1",
"contributors": [
{
"role": "rightsholder",
"person_or_org": {
"type": "personal",
"family_name": "Cruz",
"given_name": "Ashley",
"name": "Cruz, Ashley"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Clark-Garrett"
}
]
},
{
"role": "rightsholder",
"person_or_org": {
"type": "personal",
"family_name": "Peck",
"given_name": "Abigail",
"name": "Peck, Abigail"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Barnes, Hall and Ramos"
}
]
},
{
"role": "rightsholder",
"person_or_org": {
"type": "personal",
"family_name": "Davies",
"given_name": "Karen",
"name": "Davies, Karen"
},
"affiliations": [
{
"identifiers": [
{
"identifier": "03yrm5c26",
"scheme": "ror"
}
],
"name": "Russell and Sons"
}
]
}
],
"subjects": [
{
"identifier": "03yrm5c26",
"scheme": "ror",
"subject": "child"
},
{
"identifier": "03yrm5c26",
"scheme": "ror",
"subject": "strategy"
}
],
"description": "Picture risk field article. Do meeting measure nothing option drug. Marriage test evidence. Whole will paper give thing task.\nLawyer music hard report game generation answer rock. Window great surface piece involve lay all. Hour far great he close when official surface......",
"title": "Howard LLC's gallery"
},
"created": "2021-02-26 10:28:02.245807",
"updated": "2021-02-26 10:28:02.261941",
"published": true,
"status": "published",
"conceptid": "62fe3-3t414",
"revision_id": 1,
"links": {
"files": "https://127.0.0.1:5000/api/records/mrewd-axc44/files",
"self": "https://127.0.0.1:5000/api/records/mrewd-axc44",
"self_html": "https://127.0.0.1:5000/records/mrewd-axc44"
}
},
...
],
"total": 25
},
"links": {
"self": "https://127.0.0.1:5000/api/records?page=1&size=25&sort=newest",
"next": "https://127.0.0.1:5000/api/records?page=2&size=25&sort=newest"
},
"sortBy": "newest"
}
Notes¶
- The output is shortened for readability and your records will be different because they are generated randomly.
- You can use jq for color highlighting:
curl -k -XGET https://127.0.0.1:5000/api/records | jq .
Create records¶
Authentication required
All requests to the create-related REST API endpoints require authentication. To create a token, login to the application, click on your user -> Applications -> New token, enter a name and click on Create. Copy the token, since it will not be displayed again.
Create a draft¶
You can create a new record draft using the API:
curl -k -XPOST -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" https://127.0.0.1:5000/api/records -d '{
"access": {
"record": "public",
"files": "public"
},
"files": {
"enabled": true
},
"metadata": {
"creators": [
{
"person_or_org": {
"family_name": "Brown",
"given_name": "Troy",
"type": "personal"
}
},
{
"person_or_org": {
"name": "Troy Inc.",
"type": "organizational"
}
}
],
"publication_date": "2020-06-01",
"resource_type": {
"id": "image-photo"
},
"title": "A Romans story"
}
}'
Publish a draft¶
To publish it, you can take the "publish" link from the response:
"links": {
"self": "https://127.0.0.1:5000/api/records/jnmmp-51n47/draft",
"self_html": "https://127.0.0.1:5000/uploads/jnmmp-51n47",
"files": "https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/files",
"latest": "https://127.0.0.1:5000/api/records/jnmmp-51n47/versions/latest",
"latest_html": "https://127.0.0.1:5000/records/jnmmp-51n47/latest",
"record": "https://127.0.0.1:5000/api/records/jnmmp-51n47",
"record_html": "https://127.0.0.1:5000/records/jnmmp-51n47",
"publish": "https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/actions/publish",
"versions": "https://127.0.0.1:5000/api/records/jnmmp-51n47/versions",
"access_links": "https://127.0.0.1:5000/api/records/jnmmp-51n47/access/links",
"reserve_doi": "https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/pids/doi"
}
and POST to it:
curl -k -XPOST -H "Authorization: Bearer <TOKEN>" https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/actions/publish
Get a record¶
To confirm the record is published, you can search for it:
curl -k -XGET https://127.0.0.1:5000/api/records?q=Gladiator | python3 -m json.tool
or access it directly using the id from the publish response (e.g. 90xv7-xwd20):
curl -k -XGET https://127.0.0.1:5000/api/records/90xv7-xwd20 | python3 -m json.tool
Upload a file to a record¶
For demonstration purposes, we will attach this scientific photo to a record:
Photo by Jaycee Xie on Unsplash.
Save it as leaf_shiba.png in your current directory.
First, we need to work with a draft, so we create one as per above:
curl -k -XPOST -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" https://127.0.0.1:5000/api/records -d '{
...
}'
Second, we start the upload process by initializing the file key:
Change the recid
Change jnmmp-51n47 in the URLs below for the recid of your record.
curl -k -XPOST https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/files -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" -d '[
{"key": "leaf_shiba.png"}
]'
This "pre-flight" API call will allow us to support third-party source/storage in the future.
Third, we now upload the insightful picture by using the "content" link returned:
curl -k -XPUT https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/files/leaf_shiba.png/content -H "Content-Type: application/octet-stream" -H "Authorization: Bearer <TOKEN>" --data-binary @leaf_shiba.png
Fourth, we complete the upload process by using the "commit" link returned:
curl -k -XPOST -H "Authorization: Bearer <TOKEN>" https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/files/leaf_shiba.png/commit
Finally, we publish our updated record:
curl -k -XPOST -H "Authorization: Bearer <TOKEN>" https://127.0.0.1:5000/api/records/jnmmp-51n47/draft/actions/publish
This file can then be previewed on the record page and even downloaded.
Explore the API¶
To see what other API calls exist, go to the API reference section.
Stop it¶
If you want to temporarily stop the instance, without losing the data that
was generated you can use the stop command:
invenio-cli services stop
Check the Cleanup section if you wish to remove every reference to InvenioRDM from Docker (containers, images, networks, etc.).