Developer Blog - API Updates in Preservica 9.1

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 are deprecated and marked for removal. Please do get in touch if you'd like assistance migrating away from these APIs.

Entity API

The Entity API is for managing content and metadata within Preservica.

Changes since 9.0

Legal Holds

We've added a series of APIs to support legal holds within Preservica, allowing users to safeguard and ensure access to content during regulatory audits, legal proceedings, and other internal investigations.

• We've added endpoints for managing legal holds:
  • GET /legal-holds to list legal holds
  • GET /legal-holds/{ref} to retrieve a single legal hold
  • POST /legal-holds to create a new legal hold
  • PUT /legal-holds/{ref} to update an existing legal hold
  • DELETE /legal-holds/{ref} to delete a legal hold
• We've added endpoints for auditing legal hold history:
  • GET /legal-holds/events to search legal hold events across the tenancy
  • GET /legal-holds/{ref}/events to retrieve events for a specific legal hold
• We've added endpoints on information objects for applying and inspecting legal holds:
  • GET /information-objects/{ref}/legal-hold-status to get the legal hold status of an information object, including any inherited holds
  • GET /information-objects/{ref}/legal-holds to list the legal holds applied to an information object
  • POST /information-objects/{ref}/legal-holds to apply a legal hold to an information object
  • DELETE /information-objects/{ref}/legal-holds/{legalHoldRef} to remove a legal hold from an information object
• We've added bulk legal hold assignment actions:
  • POST /actions/legal-holds/assignments to bulk-assign one or more legal holds to one or more information objects
  • DELETE /actions/legal-holds/assignments to bulk-remove one or more legal holds from one or more information objects

Metadata Quality Control

• We've added actions for the new metadata clustering workflow (used in conjunction with the new Metadata Quality Control API below):
  • POST /actions/metadata-clustering to start a metadata clustering analysis over a set of entities and fields
  • POST /actions/metadata-cluster-edits to apply edits to a metadata cluster, updating the matching entities in bulk

Metadata Quality Control API

The Metadata Quality Control API is for managing metadata quality control within Preservica.

This API is provisional. It may change significantly between releases, our API Versioning Policy doesn't apply to it, and we won't support issues arising from changes in behaviour between versions

• Analysis endpoints:
  • GET /analysis to list analyses
  • GET /analysis/{id} to retrieve a single analysis
  • DELETE /analysis/{id} to delete an analysis
• Field endpoints:
  • GET /analysis/{id}/field to list the fields covered by an analysis
  • GET /analysis/{analysisId}/field/{id} to retrieve a single analysis field
  • DELETE /analysis/{analysisId}/field/{id} to delete an analysis field
• Cluster endpoints:
  • GET /analysis/{analysisId}/field/{id}/cluster to list the clusters generated for a field
  • DELETE /analysis/{analysisId}/field/{fieldId}/cluster/{id} to delete a cluster

PAR API

This API is for getting information from the Preservica Registry, and updating it if you have institution specific preservation needs. See this blog post on PAR for more information about PAR and how to use this API. Note that this API is on the Registry webapp (on the application server), not on the API webapp.

Changes since 9.0

• All PAR endpoints that return a list of objects now include paging information. To find the number of items (e.g. to populate paging controls), request with offset=0, limit=1.
• The default order for data returned from list endpoints has been updated to order by the entity name. For most PAR objects this is the GUID; for requests to file-formats it is the PUID.