Developer Features in 24R2

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

Service Announcements

Service Announcements are changes that may affect existing integrations. Organizations should assess these features against their existing integrations and make updates where necessary.

Enforce Valid License Types for Validation Management Users

Release Date: 24R1.2; May 3, 2024 May 9, 2024

Beginning in 24R2, System Administrators will only be able to select valid application license types for each application. The valid application license types for the Vault Validation Management application are:

If you have an integration that creates or updates User records in Vault, ensure that the integration assigns valid Application License values. You must check and update the integration prior to the 24R2 release to ensure the integration continues to work as expected.


Release Date: May 3, 2024 May 9, 2024

REST API v24.2

REST API features added in 24R2 only affect API v24.2, unless otherwise noted.

Bulk Undo Collaborative Authoring Checkout API

Documents checked out using Collaborative Authoring now support bulk undo checkout, allowing developers to unlock documents in bulk.

DELETE /api/{version}/objects/documents/batch/lock

View this new endpoint in the v24.2 API Reference.

Standardized Undo Checkout Permissions

Vault supports several different document lock (checkout) methods for editing documents: standard checkout, checkout to Vault File Manager, Collaborative Authoring, and using Google Drive. Each method provides a mechanism to cancel/undo an existing checkout. Starting from v24.2, the permissions governing when cancellation can be performed of another user’s checked-out document will be consistent across all checkout types.

In order for a user to delete a document lock for a document that was locked by someone else, users will need to have Edit Document permission in the document lifecycle state security settings, as well as one of the following:

New Workflows Deployed as Active

Previously, using MDL or VPK to deploy new workflows to a target Vault created the new workflows in the Inactive state. With this feature, all new workflows are now deployed in the Active state. This removes the often tedious task of manually activating new workflows after deployment.

This feature does not change the behavior of deploying new versions of existing workflows.

Create & Edit Annotations

Vault REST API v24.1 introduced the ability to read and delete document annotations. This release adds create and edit functionality for document annotations, allowing integrations to create and edit document annotations using API, including adding replies and defining annotation placement and color. Developers can also retrieve annotation metadata including annotation types and fields.

GET /api/{version}/objects/documents/annotations/types/{annotation_type}

View this endpoint in the v24.2 REST API Reference.

GET /api/{version}/objects/documents/annotations/placemarks/types/{placemark_type}

View this endpoint in the v24.2 REST API Reference.

GET /api/{version}/objects/documents/annotations/references/types/{reference_type}

View this endpoint in the v24.2 REST API Reference.

POST /api/{version}/objects/documents/annotations/batch

View this endpoint in the v24.2 REST API Reference.

POST /api/{version}/objects/documents/annotations/replies/batch

View this endpoint in the v24.2 REST API Reference.

PUT /api/{version}/objects/documents/annotations/batch

View this endpoint in the v24.2 REST API Reference.

This release also updates required body parameters for the Delete Annotations endpoint.



Document Attachments: Document Version

Document attachment queries now support retrieving the document version(s) associated with a document attachment. The document_attachments__sysr relationship on documents includes a new field, document_version_id__sys.

Learn more about querying document attachments.

VQL: Retrieve Document Signature Data

A new document relationship, document_signatures__sysr, allows developers to find documents with signatures and retrieve signature metadata including signee, task, and workflow metadata.

Learn more about querying document signatures.

Invalid Operators & Fields on Legacy Users Query Target

When using v24.2+ on the legacy users query target (users), VQL no longer supports the comparison operators (<, >, <=, >= , BETWEEN, and LIKE) in the WHERE clause. Additionally, the created_by__v and modified_by_v fields are not supported in the ORDER BY clause. Previous versions will continue to work but may return invalid results when Vaults are moved to a new domain. These changes do not apply to queries on the user__sys object.

Vault Java SDK

Java17 for Vault Java SDK: Optional Enablement

Over the next several releases, Veeva is upgrading the Vault Java SDK to Java 17 to allow developers to take advantage of the upgrades that come with the new version. In addition to new features, Java 17 includes optimizations that can improve performance and efficiency compared to Java 8, allowing for reduced resource usage.

In this release, Developers and Admins can optionally enable Java 17 for Vault Java SDK to test their custom code for compatibility with the new Java version.

Release Dates:

Object Type Translation

Developers in Vaults with multilingual labels enabled can access localized labels for object types using ObjectMetadataService. To facilitate this, ObjectTypeMetadataCollectionRequest.Builder now includes the optional withLocalizedLabels() method.

Additionally, Vault REST API v24.2+ users can retrieve localized object type labels in Retrieve Object Metadata and Retrieve Details from a Specific Object requests by setting the loc query parameter to true.

GET /api/{version}/metadata/vobjects/{object_name}

GET /api/{version}/configuration/{object_name_and_object_type}