We are pleased to bring you the following additions and enhancements to Developer Portal features in 20R1.0 REST API features added in 20R1 only affect API v20.1, unless otherwise noted.
For issues fixed in the 20R1.0 release, see the "API" category of the fixed issues list in Vault CDMS Help.
Learn more about the 20R1 release in Vault CDMS Help.
Release Date: April 17, 2020
With this release, we added the ability to create a new instance of a repeating Form or Item Group via two new endpoints, Create Form and Create Item Group. Prior to this release, an API user could only edit Form data when the repeating Form or Item Group instance was created by a user in the CDMS UI.
View these endpoints in the v20.1 API Reference
Release Date: March 12, 2020
With this release, we updated the study_name body parameter on all endpoints. study_name now requires the Study Number of the Study (study__v.name__v), instead of the External ID (study__v.name__v). External ID was not a unique value across Studies, especially in studies using the automated deployment model.
This change applies to the 19.3 and 20.1 APIs.
With this release, the Set Item Value API no longer supports setting the value of derived Items. The Set Item Value API now supports setting the value of read only Items. For example, with a Randomization form, a study designer can configure that Form to contain only read only items, which prevents site users from populating those fields. Then, randomization information can be populated by an API user.
Release Date: March 12, 2020
API users can now set the Subject Status of a Subject with the Set Subject Status API. For example, an external IxRS system can record changes to Subject Status using the API. We also added the Unset Subject Status API, which allows the Subject Status to be "unset", returning the Subject to the previously held status. This is useful when the Subject returned to a previous status or if the status was changed by mistake.
View these endpoints in the v20.1 API Reference
Release Date: March 12, 2020
API users can now create Event Groups using the Create Event Group API. For example, an external IxRS system may need to be able to add the Randomization event group to a casebook in order to record randomization details for that Subject.
View this endpoint in the v20.1 API Reference
Release Date: January 15, 2020
Developers can now choose to override the Planned Date Range and use an Event Date outside the range with Set Event Date. This feature introduces a new, optional parameter, allow_planneddate_override, which can be set to true or false. When true, Vault accepts the Event Date even if it falls outside of the planned date range. When false, Vault only accepts dates within range. If this parameter is omitted from the request body, and the provided date is outside the planned range, Vault does not save the event date.
This change affects v19.3+.