TOC Navbar
shell

Developer Features in 24R2

We are pleased to bring you the following additions and enhancements to the CDMS & CDB API features in 24R2. REST API features added in 24R2 only affect API v24.2, unless otherwise specified.

24R1.2

Study used as an alternative request parameter and in response details

Release Date: May 9, 2024 UPDATE

From 24R2, all endpoints that require the EDC study as a request parameter will allow using either study_name (referring to study_v.name_v) or study (referring to study_v.label_v) as a request parameter to identify the study. The response details will accordingly return both study_name and study where applicable. The Retrieve Studies endpoint will return both the study_name and study (same as study_label) for clarity.
Typically, the name is the same as the label, although studies are relabeled for various reasons in TST vaults.

Copy Form Definitions

Release Date: May 9, 2024 NEW

The new Copy Form Definitions endpoint supports the study build by enabling the copying of Form Definitions from another study or library study. The creation of new Form Definitions through copying is supported, but updating existing form definitions, as done in the Studio UI, is not. The forms of the latest casebook version will be selected from the source study.

Required permissions:

Retrieve Form Definitions

Release Date: May 9, 2024 NEW

The new Retrieve Form Definitions endpoint supports the study build by allowing the retrieval of Form Definitions in a study, including information on their usage in a given Casebook version.

Required permissions:

24R1.3

Create Event Group Definitions

Release Date: June 7, 2024 NEW

The new Create Event Group Definitions endpoint supports the study build by enabling the ability to add a series of Event Group Definitions. The creation of new Event Group Definitions is supported, but updating existing definitions, as done in the Studio UI, is not.

Required permissions:

Create Event Definitions

Release Date: June 7, 2024 NEW

The new Create Event Definitions endpoint supports the study build by enabling the ability to add a series of Event Definitions. The creation of new Event Definitions is supported, but updating existing definitions, as done in the Studio UI, is not.

Required permissions:

Create Schedule

Release Date: June 7, 2024 NEW

The new Create Schedule endpoint supports the study build by allowing the creation of a study schedule if none has been created yet. The endpoint only permits referencing Event Groups, Events and Forms that already exist in the Study Design.

Mandatory elements for each Event Group, Event, and Form are name, with identificaton of the study using study_name or study. Additional (optional) parameters support the detailed schedule definition.

Required permissions:

Retrieve Coding Requests

Release Date: June 7, 2024 UPDATE

From 24R2, coding request retrieval can be filtered by the Last Coded Date (last_coded_date), which must be specified as yyyy-MM-ddTHH:mm:ssZ. All coding requests created at this point in time or later are being returned.

Retrieve Users

Release Date: June 7, 2024 UPDATE

The Retreive Users endpoint now includes these additional user properties:

Property Level Property Name Description
Vault edc_user_type The type of user for training purposes (new at 24R2 and required)
Vault last_modified_by The person that last modified the user account, specifically properties unrelated to any specific study access
Study created_date For each study access of the user, when it was created
Study created_by For each study access of the user, the user that created the access
Study last_modified_date For each study access of the user, when it was last modified
Study last_modified_by For each study access of the user, the user that last modified the access

Upload Users (CSV and JSON)

Release Date: June 7, 2024 UPDATE

The main CDMS release at 24R2 includes a new required property for all administered users.
As a result, the same property must now be indicated when administering users via the API. Vault CDMS is enabling the Vault Training application for Learning Management System (LMS) purposes on EDC studies, which requires this specific distinction regarding users.

These updates will apply to all API versions. Adjustments to existing user administration integrations will be necessary on the 24R2 general release day.

Query Source Information for all Query API endpoints

Release Date: June 7, 2024 UPDATE

From 24R2, query source information about queries generated in EDC from external systems can be posted and retrieved via the CDMS API.

Query source information will now be reflected in the Audit Trail, Query Detail Listing, and Extracts. The Data Entry UI and Review UI will only display the query source information if the query source type is set to external_v. If the source type is not set to external_v, all other source information can be posted without altering the standard appearance of the query in the Data Entry UI or the Review UI.

Open Queries, Open Queries by Event ID, Open Queries by Item ID, and Open Queries by Medical Coding Request are expanded with the following optional parameters for each query entry:

Answer Queries, Close Queries, Close Queries (by ID / Batch), and Reopen Queries are expanded with the following optional parameters for each query entry:

Retrieve Queries and Retrieve Queries by ID are expanded with the following parameters:

For each query entry

For each message entry of each query