RSpace Blog

February 28, 2017

RSpace API

FAIR Data

It’s been a while since the dev team last  blogged, so we thought it about time for an update. In this post, I’ll cover some aspects of the RSpace API which we made available for the first time in 1.41.

The RSpace API is a  much-requested feature. People want to get their data programmatically out of RSpace, and also create research records automatically, for example from data generated by lab equipment.

In this first release, the API is read-only and covers a basic set of functionality to search and retrieve documents, and download attachments.

How to get started? Everything is explained in our API Getting Started Guide. In brief, you just need to generate an API key for your account on your profile page and you’re good to go. Every RSpace instance has its interactive documentation at URL path /public/apiDocs. So if you’re using our Community version, go to https://community.researchspace.com/public/apiDocs. You can either just read the documentation, or authenticate with your key and test out making API calls to your own data.

If you’d like some inspiration on what the API can do for you, please have a look at some of the projects in our Github group. We’ve been creating some example code in Python, Java and Groovy to perform the following tasks:

  • Searching documents
  • Getting documents created from a particular form, in CSV format.
  • Producing paginated lists of documents.
  • Downloading attached files.

Regular RSpace users might be aware that over the last few months we’ve been adding integrations with popular data repositories such as Figshare and  Dataverse. Now that RSpace has it’s own API, it’s pretty simple to pull documents and attachments out of RSpace and send them to Figshare programmatically  – here’s some code to illustrate this.

We’d be very keen to get any feedback on the API or its usage, or new endpoints you’d like added. Clearly, being able to post new data to create RSpace documents is a priority and we’ll be developing this over future releases. As the API matures we’ll also implement OAuth-based authentication to enable more fine-grained access control.

Thanks for reading, and of course we’re always delighted to receive any feedback or pull requests.

Richard Adams

RSpace is a fully integrated sample management and electronic lab notebook solution. Build a record of your research in an ELN that connects with the research tools you already use: request a demo or contact us to learn more.

June 30, 2022

A new website for a new era of Research Space!

News

Research Space has grow a lot in the last few years and we wanted to ensure our values and enthusiasm are reflected in how we present ourselves to the world. That's why we decided it was time for a major refresh with a brand new website!

Read more

June 30, 2022

A new RSpace edition for teams!

News

RSpace Team is a new offering that enables teams to benefit from RSpace Inventory, administrative features, more integrations, and a private cloud deployment at an affordable price tag.

Read more

June 20, 2022

Supporting Fair Data with tool integrations: DMPTool – RSpace

Integrations

We have partnered with DMPTool, a free, open source tool used to create data management plans that meet institutional and funder requirements.

Read more

May 24, 2022

Partnering with Clustermarket – Technical integration (Coming early 2022)

Integrations

We have partnered with Clustermarket to provide our users access to a premium equipment management system and offer barrier-free movement between RSpace and Clustermarket.

Read more