Service Announcements: The following upcoming changes affect all versions of the API.

[X]

Developer Features in 18R2

We are pleased to bring you the following additions and enhancements to Developer Portal features in 18R2. REST API features added in 18R2 only affect API v18.2, unless otherwise noted.

Service Announcements

Feature Change: Disable TLSv1.0 and Weak Ciphers for HTTPS

The removal of support for TLSv1.0 and Weak Ciphers for HTTPS has been deferred to the 18R3 release (November 30th, 2018) to provide customers additional time to upgrade their browsers and integrations to support TLS 1.2. Integrations that already use TLS 1.2 will continue to work.

Learn more about Veeva Vault disabling TLS 1.0 and 1.1.

Discovery Endpoint Change from GET to POST

This feature affects all versions of the API. The Discovery endpoint now supports both GET and POST requests. In 18R3 (November 30th, 2018) this endpoint will no longer support GET requests, and will instead support POST only. Please begin updating your integrations to use POST instead of GET for the Discovery endpoint.

18R1.4

Release Date: June 22, 2018

We are pleased to bring you the following additions and enhancements to Developer Portal features in 18R1.4. REST API features added in 18R2 only affect API v18.2, unless otherwise noted. View the “Developer Features” category of the Fixed Issues list for Developer Feature fixes in this release. Note that API issues are fixed for the current version only (18.2) unless otherwise noted.

Rest API

Sandbox Vaults

This feature allows users to manage the sandbox vaults using the API.

New endpoints allow API users to view, create, refresh and delete their sandbox vaults.

Sandbox vaults are used to develop and test configuration changes, data migrations, and integrations without impacting your production vault and users. Sandbox vaults are critical to an effective change control process. Creating or refreshing a “Configuration” sandbox vault copies the production vault’s configuration, ensuring the sandbox vault is an accurate replica of production suitable for making and testing changes without exposing production data. Creating a sandbox for a new project and refreshing your sandboxes often will avoid issues and delays when deploying changes in production.

Learn more about sandbox vaults in Vault Help, or view the endpoints in the v18.2 REST API Reference.

Create Placeholder from EDL Item

In API v18.2, users can trigger the action to create placeholders from an EDL item using a new API endpoint.

POST /api/{version}/vobjects/edl_item__v/action/createplaceholder

FDA Gateway Integration

This feature allows customers to send submissions to the Health Authority within Vault. Customers in RIM Submissions Vaults licensed with Submissions Publishing can use the existing Object Record User Action endpoints to send submissions to the US FDA Electronic Submissions Gateway (ESG). Vault’s integration with the FDA’s ESG allows customers to submit directly from a submissions record and receive responses from the gateway.

Dataset Support for Configuration Migration Packages

This feature allows users with Configuration Migration permissions to include data loads into an Outbound Package. This is particularly useful when migrating components that require reference data. Rather then having to perform manual data load via Vault Loader, users can now include the corresponding data load steps into an Outbound Package. Customers can also use this feature to help streamline the replication of sample test data from production to sandbox, or from sandbox to test.

We’ve also updated the Export Package and Deploy Package API response to include datasets in the VPK. We’ve also updated the Export Package API for users to download the VPK from a job.

VQL

VQL on Renditions

This feature introduces the new renditions object for VQL, a common requirement for integration and migration use cases. Using VQL on renditions allows developers to easily determine which document versions have renditions of a particular type, and retrieve rendition metadata, including its size, checksum, and file type. The renditions object supports joins with the documents object so that Vault can return rendition metadata along with document version metadata. Learn more about querying Vault renditions.

18R1.3

Release Date: June 1, 2018

We are pleased to bring you the following additions and enhancements to Developer Portal features in 18R1.3. REST API features added in 18R2 only affect API v18.2, unless otherwise noted.

Rest API

SCIM for Users

With this release, customers can use SCIM 2.0 to implement user provisioning. SCIM stands for “System for Cross-domain Identity Management”, which is a standards-based protocol designed for the exchange of user identity information between identity domains. It is a protocol by which external systems, such as Identity Providers and Authorization Services, can provision, query, de-provision and synchronize user identity data in SaaS systems such as Vault. SCIM is implemented using REST framework, allowing user identity data to be exchanged over HTTPs, using objects expressed in JSON and described in a publicly exposed schema.

Vault implementation of SCIM does not support groups or granular Vault security, such as DAC.

Learn more about SCIM in REST API v18.2 Reference

User & Person Object Enhancements

With this release, we’ve made the following enhancements to user__sys and person__sys:

Unbound Document Display Options for Binders

In this release, users can set Binder Unbound Document Display Options in the UI, which controls what version is displayed for unbound documents in binders of this document type. The Retrieve Binder and Retrieve Binder Version APIs will return document versions for unbound documents based on the binder’s document type, and display in one of the following ways:

This feature does not apply when executing VQL queries for binder contents.

Cross-Vault User Profile Images

As of this release, Vault manages the user profile image at the domain level instead of the Vault level. By setting the user profile image at the create or update time, it becomes available across all Vaults the user has access to in the home domain and the cross-domain.

Record Validation Rules

Validation rules enhance data quality by comparing user entered data with Admin defined rules for an object record. This feature allows Admins to set up simple validation rules in the UI.

If one or more validation rules fail when users create or update records via the API, the response will return an error including the names of the failing validation rules, Admin configured error messages for those rules, and their error locations. For example:

API Failure Type: “RECORD_VALIDATION_FAILURE”
responseStatus: FAILURE
Message: <Error Message configured for the Validation Rule> [<Field 1>, <Field 2>]

There is no change to the API response if every validation rule passes and the record is successfully saved. Learn more about Record Validation Rules in Vault Help.

Reason Selection When Making A Copy

This feature extends the Make a Copy functionality for PromoMats and Medcomms to allow users to select a reason when making a copy. API users can retrieve the copy_reason__v document field with the Retrieve Documents API and use the Picklists API to manage the copy_reason_picklist__v picklist.

VQL

VQL on Binders

As of API v18.2, VQL supports two new query targets: binders and binder_node__sys. With these query targets, binders become fully queryable through VQL.

Some of the most common queries this new interface is able to answer are:

You must use API v18.2 or higher to query binders.

Learn more about binder queries.

Queryable Components

With this release, API users can query most vault component objects like any other vault object. For example, components such as objecttype__sys and accountmessage__sys are available for query through VQL. Note that not all components are available for query. To retrieve a list of queryable vault component objects, use the Retrieve Object Collection endpoint.

18R1.2

Release Date: April 27, 2018

We are pleased to bring you the following additions and enhancements to Developer Portal features in 18R1.2. REST API features added in 18R2 only affect API v18.2, unless otherwise noted. You can learn more about the 18R1.2 Release in Vault Help.

REST API v18.2

Multi-Site Document Distribution

As of API v18.2, users in Clinical Vaults can now use the existing Document & Binder User Actions endpoints to initiate multi-site document distribution workflows. These workflows distribute important documents, such as protocol amendments, revised informed consent form templates, and safety information documents, to many study sites at once. Learn more about Multi-Site Document Distribution in Vault Help.

Accept Vault Session IDs as Bearer tokens

This feature allows API client applications and integrations to send Vault Session IDs inside an Authorization HTTP Request Header with a Bearer keyword, as if it was a real Bearer OAuth token.

For example: Authorization: Bearer {Vault Session ID}

Learn more about Authentication in the REST API v18.2 Reference.

Configurable Copy Fields

In this release, users can configure which fields to copy when executing the Make a Copy action on a document. Document fields have a new noCopy attribute when retrieving document field metadata, where true means this field is not copied. You cannot set the noCopy value through the API, and must do so through the UI.