TOC Navbar

Developer Features in 22R2

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

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


Close Queries by ID API

Release Date: July 29, 2022

The Close Queries by ID API allows users to close queries in batches, identifying queries to close by their ID instead of their context. Users can choose to include a message, which adds a new comment to the query while closing.

Enhancements to Retrieve Subjects API

Release Date: June 24, 2022

The Retrieve Subjects API now supports the following filter options:

In the first release of this API, it didn't have full filtering abilities for subject searches.

Pagination for Retrieve Studies, Sites, Events, Forms & Code Requests

Release Date: June 3, 2022

With this release, all retrieve APIs now use pagination. Retrieve APIs in previous API versions did not all have pagination. This change ensures no issues with large returns of data via the API.

Retrieve Study Countries API

Release Date: June 3, 2022

The Retrieve Study Countries API returns a list of Study Countries for a Study.

Retrieve Coding Definitions API

Release Date: June 3, 2022

The Retrieve Coding Definitions API returns the definitions of coding-enabled Forms in the study design.

This is needed for users of the coding APIs so they can get the available coding forms of the study, before they then do retrieving of Code Requests.

Retrieve Studies Returns Casebook Versions

Release Date: June 3, 2022

To assist with available study design, the Retrieve Studies API now includes all casebook versions of the study, for reference purposes. The return of data mentions casebook version at the site, subject, and other levels. This API assists with an API user knowing all possible casebook versions, instead of only the current version.

Retrieve Events Returns Frozen & Locked Statuses

Release Date: June 3, 2022

With this release, the Retrieve Events API now returns the frozen (frozen) and locked (locked) status of the Event or the Forms in the Event.

Prevent Updates to Forms with Lab Panels

Release Date: June 3, 2022

Due to the complexity and nature of Forms that are used in the Local Labs module, the update via API of such data is now prohibited.