TOC Navbar

Developer Features in 22R1

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

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


Release Date: March 4, 2022

Add Include Randomization Treatment Parameter for Start Job API

Release Date: March 4, 2022

In the v22.1 version of the Start Job API (Study Data Extract job type), users can choose whether to include Randomization Treatment in their extracts using the include_rand_treatment parameter (true or false). In Studies where Randomization is enabled, this adds the SYS_RAND dataset to the extract. In Studies where treatment is masked, this is only available if the user has the View Unmasked Data permission.

Start Job Supports SDE Dataset Configurator Changes

Release Date: March 4, 2022

The v22.1 version of the Start Job API (Study Data Extract job type) now allows users to specify which system datasets, clinical datasets, and custom objects they want to include in their extracts.

This adds the following parameters:

Pagination for CDMS APIs

Release Date: February 11, 2022

The CDMS API now supports pagination using limit and offset. Pagination will be supported for all GET calls going forward from v22.1. It's currently applied to the following APIs:

For requests that may retrieve and query for large amounts of data, pagination is crucial to help minimize the load on the system.

Updated Upload Users API

Release Date: February 11, 2022

With this release, we updated the Upload Users API (formerly known as Create User) to the new version, in order to support both the creation of new user accounts and adding existing users as cross-domain users. Users can also update existing Users with this API. This API now uses a CSV input file to collect the user data (CSV is the only accepted data type).

Upon SUCCESS, the newly added users will receive a Vault welcome email and the CDMS Study welcome email if they are assigned to a vault and their Activation Date isn't in the future. Cross-domain users will only receive the CDMS Study welcome email.

Query APIs to Support Coding Queries

Release Date: February 11, 2022

Users can now retrieve coding queries (queries created in Vault Coder) with the Retrieve Queries API with the coding_item_definition parameter. By specifying one or more (as a comma-separated list) Medical Coding Item Definitions for this parameter, Vault returns the coding queries opened on Code Requests for that Form.

Users can open a query against a Code Request using the Open Coding Query API.

These updates help support third party coding integrations.

Retrieve Subjects API

Release Date: February 11, 2022

The Retrieve Subjects API allows the user to request a list of all Subjects in a given Study. Vault returns the following details about each Subject:

Retrieve Job Status Returns User Name for created_by

Release Date: February 11, 2022

The Retrieve Job Status API now returns the User Name value for the User who started the job for the created_by value in the response.

Include Item Counts for Start Form Progress Listing Job

Release Date: February 11, 2022

With this release, users can choose to request item counts when running the Form Progress Listing job. This applies to the v22.1 of the Start Job API when users run the Form Progress Listing (form_progress_listing__v) job type and include the parameter include_item_counts in the request body.