Developer Features in 21R2

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


Release Date: April 30, 2021

REST API v21.2

Restrict Document Workflow to a Single Document

We are adding some new attributes as part of this feature for Object and Document(formerly MDW) workflows.

Attribute type is getting added with all workflows. This will determine whether a workflow is Object or Document (formerly MDW) workflow.

Attribute cardinality determines whether you can have only one or many documents. For e.g.

GET /api/{version}/objects/documents/actions/{workflow_name}

will return type as Document and cardinality as One if it’s a Document workflow and can be used with only one document.

Learn more in the v21.2 API Reference.

Task Completion API Enhancement

Retrieve Task Complete API

GET /api/{version}/objects/objectworkflows/tasks/{task_id}/actions/complete

now returns tasks with eSignature.

Completion of tasks with eSignature continues to remain blocked through APIs.

Learn more in the v21.2 API Reference.

Display the Unclassified Doc Type in Admin

The Unclassified document type (labeled as “Undefined” in previously created vaults) is now a child of the Base Document type and visible in the Vault Admin UI. You can assign fields and document type groups to the Unclassified document types, and can also create document permissions on the document type. Note that required fields are not enforced while a document remains in the Unclassified document type (or the Inbox lifecycle).

Auth & Change My Password: User Credentials as Body Parameters

Starting from v21.2, the Authentication and Change My Password REST APIs ignore user credentials passed as query String parameters. These APIs only accept the username and password as body parameters. In previous API versions, we recommend using the body for these parameters as a best practice.

Audit API Returns Nulls

Audit API JSON responses now include null instead of empty strings when a field is blank. This change only affects v21.2+.

Learn more in the v21.2 API Reference.


Number Precision for Document Field Queries

This feature enhances the decimal precision of field values for Number fields. As of VQL v21.2+, document read precision is based on the number field’s configured Decimal places.

For example, if you save a document number field with a value of 3.0 and the Decimal places for that field is configured as 2, you will see a field value of 3.00 in VQL query results.

Learn more about querying number fields with VQL.

To make filtering consistent across Vault Objects, we are enhancing the related object section filters to use Criteria VQL. Any existing filters will remain unchanged and continue to function as before. Vault will automatically convert legacy filters to Criteria VQL upon edit of the related object section.

Previously, there was an Apply on Create feature that allows an Admin to specify at the individual criteria level indicating if the criteria will be used as default for creating new records. In this release, the Apply on Create feature has been changed to apply to all criteria instead of applying at the individual level.

Vault Java SDK

Object Metadata Service Field Type Support

Starting in 21R1.2, object field types and value types are now available for retrieval as part of the ObjectMetadataService. This functionality is extremely useful for use cases where the custom Java SDK code needs to have conditional logic based on the type or value type of a field.

Support PATCH on HttpRequest

HttpRequest now supports the PATCH verb when making REST API calls with the HttpService.