We are pleased to bring you the following additions and enhancements to the CDMS & CDB API features in 23R3. REST API features added in 23R3 only affect API v23.3, unless otherwise specified.
Release Date: August 18, 2023 NEW
The new "Retrieve Email Groups" endpoint will allow for the study-specific retrieval of information on Email Groups, including the group name, ID, and member count. With the introduction of the "Retrieve Email Group Members" endpoint, member details of an Email Group can be retrieved using either the Email Group name or ID. New members can also be added and existing members can be updated or deleted with the new "Update Email Group Members" endpoint.
Once the conditions of a Send Email rule are met, email notifications are sent to the members of the configured Email Group. These new endpoints expand user management capabilities by enabling Email Group Members management via API.
Release Date: August 18, 2023 UPDATE
Select Forms and Events endpoints now allow for an optional change reason. If the change reason is omitted, although the update action requires a reason for change, a default reason will be provided.
This enhancement applies to the following endpoints:
For update actions where no reason for change is required (for example, blank forms), the system now allows you to choose whether or not to provide a change reason. This facilitates timely updates without the need for prior inspections of forms and events, in line with the 23R1 released combination form update API.
Release Date: August 18, 2023 UPDATE
The endpoint now includes datetime values for:
Release Date: August 18, 2023 UPDATE
The endpoint now includes datetime values for:
Release Date: September 15, 2023 NEW
The new Retrieve Study Roles endpoint allows you to retrieve all Study Roles from a Vault, both standard and custom. The Study Roles are listed, including the role name, assigned team, and the permissions as granted (true) or not granted (false). The View Users permission is required for this request.
Release Date: September 15, 2023 NEW
The new Retrieve Study Masters endpoint helps retrieve information on selected or all Study and library Collections in a Vault. Details for each instance of a Study Master include name, creation and deploy dates, environment type, status, and build information. This serves as the foundation for controlling automated Study builds in the future. The View Study and View Library permissions are required for this request.
Release Date: September 15, 2023 NEW
The new Create Study Master endpoint extends the Study Design section of the CDMS API. The “create” action is identical to the New Study and New Collection actions in Studio. With this endpoint, both a Study Master and an initial development instance or environment are created. Other study instances, such as Test, Training, and Production, are not created using this endpoint.
For this request, you’ll need the Design Study permission to execute the equivalent of a New Study action and the Design Library permission to execute the equivalent of a New Collection action.
Release Date: September 15, 2023 NEW
The new Upsert Users endpoint enhances current User Management capabilities by allowing you to add and update user details in JSON format without uploading a CSV file. The required data values and request responses are identical to those of the CSV file upload functionality and will be restricted to batches of 100 users per request (maximum).
Release Date: September 15, 2023 UPDATE
The response body of this endpoint has been expanded to include additional details about the study, including the locked status, connection, environment and build. The return value for study is now identical to the study label.
Release Date: October 13, 2023 UPDATE
The API to start a CDMS study job supports the new job type Data Change Report. This new job is similar to the audit trail jobs, but narrowed to just item data changes over a date range, or the past few days.
Release Date: October 13, 2023 UPDATE
Query APIs have been updated to include information about the source system of the query, i.e. if it was added through the API.
source_id for a Query level indication from the source system. The value is limited to 64 charactersmessage_source_id for a Message level indication from the source system. (i.e. the first message of the new query) The value is limited to 64 characterscheck_source_id_unique = true to have CDMS verify that there is no other Query in the study with the same source ID value. Depending on the use of source ID relative to the non-CDMS system, it might be expected that this value will be non-unique, e.g. a 'rule' in that system that originated the query. Or, it could be a unique identifier of query back in the source system, and this check ensures there are no duplicates added in error. message_source_id for a Message level indication from the source system. (i.e. the transaction or user from that source system) The value is limited to 64 characters