API Client Code Examples
Updated
In order to show the capabilities or our API and demonstrate user cases requiring multiple API calls, we are developing rich language bindings and example code on our open-source Github repository.
Currently we have generated example client code using Python, Bash, Groovy and Java but we welcome suggestions for other languages or examples from our users.
Python Examples
Our Python API project is hosted on GitHub here.
This project contains a client which helps calling RSpace APIs and some example Python scripts.
The examples of client code include:
- A basic query to list documents
- Iterating over pages of results
- Searching using advanced and simple queries
- Retrieving document content
- Getting attached files
The examples use the rspace_client package which provides an abstraction over lower-level libraries and is compatible with both Python 2 and Python 3.
We also have an overview of round trip data analysis using Jupyter notebook and the RSpace API.
The client package is available both on the GitHub sit and the Python packages website here: https://pypi.python.org/pypi/rspace-client/0.0.2
Groovy Examples
Our Groovy API project is hosted on GitHub here.
The examples of Groovy client code include:
- A basic query to list documents
- Iterating over pages of results
- Searching using advanced and simple queries
- Retrieving document content
- Getting attached files