TOC Navbar
shell

Developer Features in 21R2

We are pleased to bring you the following additions and enhancements to Developer Portal features in 21R2. REST API features added in 21R1 only affect API v21.2, unless otherwise noted.

For issues fixed in a release, see the "Developer Features" category of the fixed issues list in Vault CDMS Help.

REST API

Updated Retrieve Users API

Release Date: June 25, 2021

This release includes a new version of the Retrieve Users API, which allows the retrieval of all Users in a vault, Study, or information for a single User. The Retrieve Users API requires the API Access, View Users, and Manage Users permissions.

Activate & Inactivate Users via the API

Release Date: June 25, 2021

With this release, we added the Activate User and Inactivate User APIs. Inactivating a user prevents that user from accessing Vault, but it does not remove the user account from the system. Vault doesn't allow the deletion of Users, but you can make the user inactive. Activating a user allows the user to access Vault when they were previously inactive. These APIs require the API Access, View Users, and Manage Users permissions.

Open Query by Item ID or Event ID

Release Date: June 25, 2021

When opening a new query, API users can now locate the Item or Event Date by the Item ID or Event ID, instead of identifying the Item or Event using the study object hierarchy. This allows users to input fewer parameters when opening a query. It also distinguishes between opening a query on an Item versus an Event Date.

The Open Query by Item ID and Open Query by Event ID APIs require the API Access, View Casebook, and Open Query permissions in the Study Role, as well as access to all sites.