Developer Blog - API Updates in Preservica 9.0

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 9.0. Please do get in touch if you''d like assistance migrating away from these APIs.

Entity API

This API allows you to view and manipulate entities within Preservica.

Changes since 8.5

• POST /actions/metadata-replace requests now accept an optional wholeTerm flag on each ReplaceFields entry, alongside the existing matchCase and wholeWord flags. The flag defaults to false when omitted
• POST /actions/policy-evaluations now lists External_Content as a valid policy type, in addition to Metadata_Enrichment and Preservation
• POST /information-objects/{ref}/preview (and the equivalent endpoint on structural objects) now requires both UPDATE_METADATA and INSERT_CONTENT permissions on the target entity
• DELETE /information-objects/{ref}/preview (and the equivalent endpoint on structural objects) now requires both UPDATE_METADATA and DELETE_ENTITY permissions on the target entity

Content API

This API powers search and content retrieval.

Changes since 8.5

• The search endpoints (GET /content/search, GET /content/search-within, GET /content/search-export, GET /content/object-children and GET /content/top-level-objects) now reject queries whose sortFields reference index fields that are not configured as sortable, returning 400 Bad Request
• GET /content/thumbnail now enforces the READ_CONTENT permission on the target entity.

Settings API

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

Changes since 8.5

• The Metadata Enrichment configuration documentation for the Transcription and Captioning profile has been updated for new functionality: the optional task property accepts transcribe (the default) or translate. For more information, see Preservica 9.0 Release Notes.

Metadata API

This API allows you to manage metadata schemas, groups and forms.

Changes since 8.5

• GET /groups/{id} now returns an empty string for description when a group has no description set, instead of returning null