Developer Blog - API Updates in Preservica 8.5

For a summary of all our APIs, you can use the documentation index page.

Deprecation notice reminder

We previously indicated that /api/accesstoken/acquire-external and the SOAP web service for managing workflows would be removed, but both have received stays of execution. These are still deprecated, but continue to be available in 8.5. Please do get in touch if you'd like assistance migrating away from these APIs.

Content API

This API allows you to access and retrieve content from Preservica.

Changes since 8.4

• The GET /object-details endpoint has a new optional excludeproperties query parameter. This allows you to exclude specific property groups from the response — currently supporting history (which omits cmis:createdBy, cmis:creationDate, cmis:lastModifiedBy and cmis:lastModificationDate). Excluding groups avoids unnecessary database queries and can improve performance

Metadata API

This API allows you to work with metadata schemas and indexed fields within Preservica.

Changes since 8.4

• The GET /indexed-fields endpoint has been enhanced with two new optional query parameters:
  • editable-fields-for-refs - Limit results to editable fields used by specified Structural Objects or Information Objects and their children. Non-editable fields (such as reference metadata fields and most XIP fields) are excluded from this filter
  • index-types - Filter fields by their index types (STRING_DEFAULT, STRING_EXACT, STRING_FACET, LONG, DATE). Only fields matching the specified types will be returned

Settings API

This API allows you to view and update configuration for Preservica.

Changes since 8.4

• We've added a new GET /overages endpoint to list overage settings for your tenant. This allows you to view configured limits and modes for feature usage that may exceed standard entitlements
• We've added a new PUT /overages endpoint to update overage settings for your tenant. You can configure the overage mode (e.g., ALLOW, BLOCK) and set overage limits for specific features. Setting an overage limit to -1 enables unlimited usage