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.

21R1.2

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.

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.

VQL

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 HttpService.

21R1.3

Release Date: June 4, 2021

REST API v21.2

Prevent Reclassify for Checked-out Documents

For all versions of the API, the Reclassify Document endpoint no longer allows reclassification for documents that are currently checked out.

PUT /api/{version}/objects/documents/{doc_id}

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).

Learn more about configuring document types in the Vault Admin UI in Vault Help.

Relabel “Undefined” Document Type to “Unclassified”

In vaults created after 21R2, the Undefined document type is relabelled as Unclassified. We recommend that customers update their existing vault configurations with the new label.

Relabel “Unclassified” Lifecycle to “Inbox”

In vaults created after 21R2, the Unclassified document lifecycle is relabelled as Inbox. We recommend that customers update their existing vault configurations with the new label.

Admins Can Edit All Picklist Labels & Picklist Value Labels

Standard picklist labels and picklist value labels can now be updated in admin and via API and MDL.

Read and Understood Document(MDW) Workflows

This feature allows administrators to create and run “Read and Understood” workflows for multiple documents.

Read and Understood workflows can’t be started using the Multi-Document Workflow APIs, however, Read and Understood tasks can be completed, reassigned, or canceled using the Initiate Workflow Action APIs.

GET /api/{version}/objects/objectworkflows/{workflow_id}/actions

GET /api/{version}/objects/objectworkflows/{workflow_id}/actions/{workflow_action}

POST /api/{version}/objects/objectworkflows/{workflow_id}/actions/{workflow_action}

When querying Read and Understood workflow tasks, the Retrieve Workflow Tasks and Retrieve Workflow Task Details endpoints now include the workflow_class__sys field in the response with a value of read_and_understood__sys.

GET /api/{version}/objects/objectworkflows/tasks

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

Learn more in the v21.2 API Reference.

Include Inactive Classification on Single Document Version

When retrieving single document versions, previous versions of the API return null for classification__v when the classification is inactive. In API v21.2+, inactive classifications return the classification name.

Facetable Attribute

Metadata describe queries on documents and objects will now return a “facetable” attribute with each field to indicate which fields will return facets when searching document or object tabs in the Vault UI.

VQL

VQL for Document Workflows

This feature allows VQL developers to query Document Workflows (formerly multi-document workflow), workflow tasks, and supports relationships to document and user data. To access this data, we’ve introduced new query targets for actively running workflows and completed (or cancelled) workflows. Query results can be sorted, filtered, and paginated.

Learn more about querying document workflows in the VQL documentation.

Vault Java SDK

Vault Java SDK Service Account

Custom Vault Java SDK code now executes as the new Java SDK Service Account. Audit trails reflect this change, where events will be logged as java_sdk_service@{domain} on behalf of {username}. The runtime behavior of existing code will not be impacted by this change, only the audit trail entries will be different.

JSON Binding Annotations: User-Defined Model and Property

This features introduces a new Vault Java SDK code type, user-defined model, which supports annotating getters and setters on a Java interface as a user-defined property. Using JsonService, developers can serialize a model to JSON and deserialize JSON to a model. Additionally, user-defined models can be used with HttpService to send and retrieve data using REST APIs.

Learn more about User Defined Models.

Audit Enhancements: On Behalf of User

System and Application events that make data changes will be logged as System on behalf of {username}, which provides additional visibility into which user’s actions caused data to be created, updated, or deleted. Previously, these audit entries were logged simply as System. Existing audit entries will not be altered and only new audit entries will reflect this additional information.