Elements API
Importing Data into Elements User Profiles
This document describes how to import user profile data into Elements using the Elements REST API, and discusses related issues. The term ‘user’ is us...
Postman API Collection
A Postman collection of API operations. v6.13 Collection v5.5 Collection The following environment variables should be set up to test operations: ba...
Should I use the API or the reporting database?
Symplectic Elements offers two interfaces for the automated bulk extraction of research data: the API and the reporting database. What are their purp...
How to get a secure Elements API endpoint running
N.B. This guide applies to clients hosting their own instances of Elements. If Symplectic hosts your Elements instances, please raise a support ticket...
Manage the Elements API
The Elements API (Application Programming Interface) is one of the two methods by which the Elements system interacts with other systems within yo...
API Administrator Guide
This document provides administrator documentation for the latest Elements API version (v6.13) and provides your administrative and IT staff with th...
API Schemas
Please select the schema that is appropriate to the endpoint you are developing against. Elements API v6.13 Schema Elements API v5.5 Schema Note: No ...
How to use the PATCH record API operation
The PATCH record API operation was introduced in API v4.9 to offer a method of performing partial modification on records. The examples provided in th...
Hello world code: implementing a user import feed
Please review Managing Users , Elements User Groups , and Managing User Groups before implementing a user import feed. There are two alternative a...
Changes between API v5.5 and v6.13
This article enumerates the backwards breaking changes between the Elements v5.5 and v6.13 API endpoints. For those wishing to migrate between endpoin...
API v5.5 Resources and Operations
Note this article is no longer updated. Please view the Postman API Collection for the latest updates. This article provides user documentation for...
v6.13 Requests and Responses
This article provides user documentation for the Symplectic Elements API and provides your technical staff with the ability to fully integrate staff...
API v5.5 Requests and Responses
This article provides user documentation for the Symplectic Elements API and provides your technical staff with the ability to fully integrate staff...
API User Guide
Together with the accompanying XML schema , the linked articles provide user documentation for the Symplectic Elements API and provides your techni...
Announcement: Minor upcoming API change in v6.4
A small change will be made to the XML data serialised for publications in the Elements API v5.5 compatibility endpoint in the upcoming v6.4 release o...
How to use the Post user identifier Associations API operation to bulk import user identifiers
Pre-requisite : You will need Elements V5.11 or higher. This example shows an HTTP request that can be used to bulk import user identifier association...
Hello world code: Implementing a data import feed
The Symplectic Elements API provides operations that allow you to import your research data into the system in a manner that is designed to closely re...
Annual Collection API
This example shows how to nominate a publication for an Annual Collection. Publication's reporting date must be in the Collection year (2017 in this e...
How to use the Patch object API operation to update Labels
This example shows an HTTP request that can be used to update the labels attached to a publication. By using the PATCH verb we can send only the affec...
Hello world code: nightly publication import feed
This example code was used in a live demo at the Symplectic User Technical Conference in October 2012 to demonstrate an approach to implementing a nig...