We are pleased to bring you the following additions and enhancements to Developer Portal features in 19R3.0. REST API features added in 19R3 only affect API v19.3, unless otherwise noted.
For issues fixed in the 19R3.0 release, see the "API" category of the fixed issues list in Vault CDMS Help.
Learn more about the 19R3.0 release in Vault CDMS Help.
Release Date: November 1, 2019
With this release, we introduced the Vault CDMS API. Organizations can use the API to support integrations with external systems.
This release includes the following endpoints:
| API Name | Description |
|---|---|
| Get Studies API |
This API allows user to get a list of all studies. If a customer doesn’t know the Study Names used for other APIs, they can use this endpoint to retrieve them. Vault only returns studies the user has permission to access. GET |
| API Name | Description |
|---|---|
| Create Casebook API |
Create a new Casebook, with first Event Group and Event in the Unplanned status POST |
| API Name | Description |
|---|---|
| Set Event Dates API |
Set the Event Date for an Event POST |
| API Name | Description |
|---|---|
| Set Item Value API |
Set data on a form POST |
| Submit Form API |
Submit a form POST |
| Edit Submitted Form API |
Move a submitted form into edit mode and provide a reason for change. POST |
| API Name | Description |
|---|---|
| Retrieve Queries API |
Retrieve a list of queries GET |
| Open Query API |
Open a query on an Item or Event Date POST |
| Answer Query API |
Answer a query with message POST |
| Close Query API |
Close a query with an optional message POST |
| Reopen Query API |
Reopen a query with a message POST |
| API Name | Description |
|---|---|
| Retrieve Users API |
Retrieve a list of Users in a Study POST |
| Create User API |
Create a new User and assign that User a Study Role for a Study GET |