API Changelog
Updated
This document records changes to the RSpace ELN API and its documentation across releases of RSpace. The API is backwards compatible.
- API documentation for your installation is at
https://YOUR_RSPACE.researchspace.com/public/apiDocs - API documentation for Community server
RSpace 1.75 ( from February 28th 2022)
Issue name | Type | Affected endpoints | Description |
2474 | NEW ENDPOINT | /sysadmin/users GET | As a sysadmin, get paginated listing of user details |
RSpace 1.70 (September 2021)
This release of RSpace contains the long-awaited module. All Inventory capability is accessible through its API. Please see Inventory API introduction for more details
RSpace 1.69.51 (July 2021)
Issue name | Type | Affected endpoints | Description |
2316 | NEW REQUEST PARAM | /export POST | Can request export to include revision history, using 'includeRevisionHistory=true' in request URL |
RSpace 1.69.34 (February 2021)
Issue name | Type | Affected endpoints | Description |
2224 | ENHANCED SYNTAX | /documents POST /documents PUT | Can include links to external files in OneDrive, Box and Dropbox. See Swagger documentation for details |
RSpace 1.69.19 (August 2020)
Issue name | Type | Affected endpoints | Description |
2148 | NEW REQUEST PARAM | /export/{format}/{scope} POST | New scope option 'selection' to export specific documents, folders, notebooks or Gallery items. New request params 'selections' and 'maxLinkLevel' |
RSpace 1.69.18 (August 2020)
Issue name | Type | Affected endpoints | Description |
2121 | BUG | /jobs/{id} GET | The 303 response code for a completed Job was not correct, as a Location header was not provided. A completed Job now returns 200 code instead. Clients can use the status of 'COMPLETED' and non-null |
RSpace 1.66 (November 2019)
In 1.66 is new API to navigate folder trees, and initial support for OAuth (read more about getting started with OAuth for RSpace)
API version 1.6.1
Issue name | Type | Affected endpoints | Description |
1763 | NEW ENDPOINT | /oauth/token POST | Standard OAuth 'password' and 'refresh_token' support. |
1918 | NEW ENDPOINT | /folders/tree GET | List items in Home folder |
1918 | NEW ENDPOINT | /folders/tree{folderId} GET | List items in specified folder |
RSpace 1.60 (August 2019)
In 1.60 is new API that we've found useful internally within RSpace for testing purposes, but may not be fully stable yet. These APIs enable sysadmin users to create new users and groups. To enable this 'beta' API, please restart RSpace with api.beta.enabled=true set in deployment.properties. We will consider altering or enhancing the API from feedback we receive.
API version 1.5.4
Issue name | Type | Affected endpoints | Description |
1872 | NEW ENDPOINT | /users POST | beta Sysadmin can create a new user account. |
1872 | NEW ENDPOINT | /groups POST | beta Sysadmin can create a LabGroup from existing users |
RSpace 1.59.2 (July 2019)
API version 1.5.3
Issue name | Type | Affected endpoints | Description |
1865 | NEW ENDPOINT | /files/{fileId}/file POST | Replace a previously uploaded file with a new version, reproducing the same behaviour as in the web application |
RSpace 1.58 (April 2019)
API version 1.5.2
Issue name | Type | Affected endpoints | Description |
1761 | NEW ENDPOINT | /import/evernote POST | Import an Evernote .enex file to be converted to RSpace document |
RSpace 1.57
API version 1.5.1
Issue name | Type | Affected endpoints | Description |
1725 | NEW REQUEST PARAM | /import/word POST | Optional parameter ‘imageFolderId’ to specify a folder in ImageGallery for embedded images in Word documents to be uploaded to. |
1702 | ENHANCED SYNTAX | /files POST | Formatted links to folders and notebook links can now be added in using ‘<ID>‘ syntax |
RSpace 1.56
API version 1.5.0
Issue name | Type | Affected endpoints | Description |
1702 | NEW ENDPOINT | /groups GET | Get listing of groups that the API user belongs to |
1702 | NEW ENDPOINT | /share POST | Share one or more documents or notebooks with groups or users |
1702 | NEW ENDPOINT | /share GET | Lists or search for Shared Items |
1702 | NEW ENDPOINT | /share/{id} DELETE | Unshare a document or notebook |
1696 | NEW ENDPOINT | /forms/{id} DELETE | Delete a new or unused form |
1696 | NEW ENDPOINT | /documents/{id} DELETE | Marks a document as deleted. |
1696 | NEW ENDPOINT | /folders/{id} DELETE | Removes a folder or notebook |
1702 | NEW ENDPOINT | /import/word POST | Import a Microsoft Word or OpenOffice document as an RSpace document |
RSpace 1.54
API version 1.4.1
Issue name | Type | Affected endpoints | Description |
1610 | BUG | /documents/{id} | Defect: Embedded form info did not include a _self link to the form’s full resource Fix: Self links are included now in form info objects |
RSpace 1.50
API version 1.4
Create and retrieve Folders and Notebooks.
Create, list and manage Forms.
Issue name | Type | Affected endpoints | Description |
1477 | NEW ENDPOINT | /folders POST | Create a new folder or notebook |
1477 | NEW ENDPOINT | /folders/{id} GET | Gets a single folder or notebook by its ID |
1481 | NEW ENDPOINT | /forms GET | Lists or search for Forms |
1481 | NEW ENDPOINT | /forms POST | Create a new Form |
1481 | NEW ENDPOINT | /forms/{id} GET | Gets a single Form by its ID |
1481 | NEW ENDPOINT | /forms/{id}/share PUT | Shares a Form with your group |
1481 | NEW ENDPOINT | /forms/{id}/unshare PUT | Unshares a Form from your group |
1481 | NEW ENDPOINT | /forms/{id}/publish PUT | Publishes a Form |
1481 | NEW ENDPOINT | /forms/{id}/unpublish PUT | Unpublishes a form |
RSpace 1.47
API version 1.3
New endpoints to export work asynchronously and track progress:
Issue name | Type | Affected endpoints | Description |
1315 | NEW ENDPOINT | /export POST | Export your work to XML or HTML format. |
1315 | NEW ENDPOINT | /jobs/{id} GET | Retrieve job progress |
1315 | NEW ENDPOINT | /export/{id} GET | Download an export. |
RSpace 1.46
API version 1.2
New endpoint to get activity logs:
Issue name | Type | Affected endpoints | Description |
1319 | NEW ENDPOINT | /activity GET | Get activity records for you or your group. |
RSpace 1.45
API version 1.1
New endpoints to create content and upload files
Issue name | Type | Affected endpoints | Description |
1276 | NEW ENDPOINT | /documents POST | Create a new document |
1276 | NEW ENDPOINT | /documents/{id} PUT | Edit an existing document |
1276 | NEW ENDPOINT | /files POST | Upload a file |
1276 | NEW PROPERTY | /files/{id} |
|
RSpace 1.42
API version 1.0.0
Issue name | Type | Affected endpoints | Description |
1154 | BUG | /documents/{id}; text/csv | Defect: Any exceptions thrown internally resulted in an HTML error page being returned. Fix: Error responses are now returned in CSV format; the Swagger documentation has been altered to state this. |
1165 | BUG | /documents/{id} | Defect: Timestamps were in local time, even though they were described in ISO8601 format and UTC time. Fix: Timestamps for created / lastModified properties now show correct UTC time. |
1165 | NEW PROPERTY | /files/{id} | created is the creation date of the File (the time it was loaded into RSpace, in ISO-8601 format). |
1165 | NEW PROPERTY | /status | rspaceVersion shows server version. |
RSpace 1.41
API version: 0.1
This is the initial release of the API
Roadmap
There are currently no planned new API endpoints, but we are happy to receive suggestions!