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

[X]

Developer Features in 18R3

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

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.

Vault Java SDK

The Vault Java SDK is a powerful tool to apply custom business logic by programming solutions in Java. It provides complete development and deployment lifecycle support from coding and debugging in an IDE to migrating code from sandbox to production vaults.

Documentation and sample code are available in the Developer Portal. The Developer Community can provide additional details.

Record Triggers

This feature allows customers to apply custom business logic before and/or after records are created, edited, or deleted. Organizations can use record triggers to improve data quality by performing complex data validations and field value defaults. Record triggers can also automate business processes by starting workflows, changing lifecycle states, or creating related records. Record triggers are written in Java programming language.

Record and Document Actions

Record and document actions allow customers to provide custom logic that users invoke from a record or a document. These actions can also be developed as document lifecycle entry actions. Record and document actions are written in Java programming language.

Interactive Debugger

This feature allows developers to develop code in their own familiar IDE and debug their code locally by stepping through to troubleshoot issues. The debugger allows developers to easily test their code before deploying it to Vault for others to test or use. Separately, a Debug Log is available to troubleshoot issues with deployed code running in production.

Code Deployment

With his functionality, developers can deploy code from their local file system or source control build automation tools to Vault. Code is easy to upload and deploy using Vault’s Configuration Migration Tool. Admins can also migrate code from sandbox to production vaults using this tool.

Admin UI

This feature allows developers and Admins to view lists of code deployed in a vault. Admins can also use this UI to download the source code and perform other actions.

REST API v18.3

Retrieve Results from an Extensible Controlled Copy Job

Release Date: 18R2.4, October 12, 2018

Following the release of Extensible Controlled Copies, we added support for downloading a Controlled Copy package directly from the API. This now allows integrations to both request a controlled copy, and download it from Vault in a fully automated way.

View this endpoint in the v18.3 API Reference.

Update Corporate Currency Values

Release Date: 18R2.4, October 12, 2018

When currency rates or the corporate currency itself has changed, Vault does not auto-update existing object records. With the updatecorporatecurrency object action, you can update the existing corporate currency field values when changes to the currency occur.

This action updates all corporate currency fields in an object record. If users don’t provide a record id in the request body, the API will update all corporate currency fields for all records for a given object.

Extensible Controlled Copy

Release Date: 18R2.3, September 21, 2018

Extensible Controlled Copy allows QualityDocs application users to request a specially overlayed and tracked copy of a document from Vault. You can initiate this request through the Vault REST API the way you usually would, with the existing Initiate User Action endpoint. The requested documents are delivered to the requesting user through email and a notification in Home > Notifications.

Vault Context in Login Audit History

Certain Vault logins occur at the domain level. When such login events occur, their login audit records are visible across all Vaults in the domain. This feature exposes the Vault ID for individual login events when the Login Audit History (login_audit_trail) is retrieved using the Audit API. Vault-specific login events will have the Vault ID (vault_id) exposed, while the login events which are domain-level will not.

Multi-Document Workflow

Release Date: 18R2.3, September 21, 2018

Multi-document workflow enables sending multiple documents on a single workflow instance. In support of this feature, we’ve introduced new API endpoints and updated existing ones to manage multi-document workflows and their tasks. With these API’s, users can do the following:

OAuth 2.0 / OpenID Connect Profile Enhancements to support ADFS

Release Date: 18R2.3, September 21, 2018

With this feature, Vault supports ADFS as the Authorization Server for the client applications which integrate with Vault using OAuth 2.0 / OpenID Connect protocol, such as Vault File Manager. This feature allows configuring the type of the Authorization Server. This configuration will manifest itself through the Discovery API. If the Authorization Server Type is specified as ADFS, the Discovery response will contain a use_adal boolean field set to true, else it will be set to false. If set to true, this advises the client applications to utilize Microsoft Modern Authentication™ (ADAL) to authenticate the users, if set to false, clients should use the standard OAuth 2.0 / OpenID Connect instead.

Complete Audit History

Release Date: 18R2.3, September 21, 2018

In this release, we added two new Audit API endpoints for retrieving the complete audit history for a single document or object record. You cannot request complete audit history for more than one object or document in a single request. These endpoints honor the API security permissions as well as the record and audit trail security. As with the existing audit log endpoints, users can specify a start and end date as a query parameter. If no start or end date parameters are specified, the system will automatically return the complete, all-time audit trail for the requested record or document.

Retrieve Domains

Release Date: 18R2.3, September 21, 2018

This new v18.3 API allows non-domain Admins to retrieve a list of all their domains. You can use this data as a valid domain value when creating a sandbox vault.

GET /api/{version}/objects/domains

Max Value Limit Property for Document Fields

Release Date: 18R2.3, September 21, 2018

As of 18.3, if object reference limits have been updated in your vault, the Retrieve All Document Fields API returns the new maxValue attribute.

VQL

Synonyms Queries

Release Date: 18R2.4, October 12, 2018

With this release, performing a keyword search on documents with VQL includes results with any synonyms defined in the vault’s thesaurus, as described by the Synonyms feature. Learn more about Synonyms in Vault Help.

Currency Data Type Support

Release Date: 18R2.3, September 21, 2018

This feature allows customers to configure currency fields on Vault objects. When using VQL to query currency fields, Vault returns the stored numeric value like any other number field. You can query both the currency and the associated corporate currency fields independently, however, you must use the field name <field name>_corp_sys to retrieve the corporate currency numeric value.

Maximum Query String Length

Release Date: 18R2.3, September 21, 2018

The maximum length of a VQL statement is 50,000 characters, up from 10,000. This applies to all versions of VQL.

VQL on Groups

Release Date: 18R2.2, August 17, 2018

As of API v18.3, VQL supports queries on Groups. Using a new group__sys query target, users can execute granular queries to fetch group information as well as join groups with users, and users with groups. Using this new powerful functionality, users can determine the groups users belong to as well as groups containing users. Vault supports all standard VQL functionality by this new query target.

Learn more about group queries.

VQL on Binders Enhancements

Release Date: 18R2.2, August 17, 2018

The Binders VQL now adds support for type__sys field in the binder_node__sys object. Using this field, customers can construct more refined queries filtering by specific types of binder nodes, such as section or a document. Additionally, customers can now use the VQL QueryDescribe mechanism to describe the queries on binder__sys and binder_node__sys query targets. Learn more about binder queries.

Vault Components

Report Migration Supports Share Settings

Release Date: 18R2.2, August 17, 2018

Report components now support share settings. This allows Admins to easily migrate both the report and the users assigned to various roles for that report.