Preservica APIs - reference information
Learn more about Preservica APIs here and how to get up to speed with our extensive API library
The API Reference section describes a number of high-level interfaces that can be used by external systems to automate and interrogate a deployed Preservica system.
|Preservica Entity REST API||Provides read access to the full Preservica data model, plus endpoints for entity creation and modification, and for package upload|
|Upload Content (S3 Compatible)||Implementation of S3 protocol for package upload, including multipart upload for large packages|
|Progress Token API||Allows for monitoring of long-running tasks (such as file upload via Entity API)|
|Process Monitoring API||API for retrieving and updating monitoring information about processes|
|Access Token API||Authentication API that generates time-limited access tokens required by the remaining APIs|
|Preservica CMIS Interface||A standard protocol for interaction with content management systems|
|Content API||Search-based, read-only API for accessing metadata and content for display on discovery platforms|
|SIP Creator Command Line||Command-line program for creation of Preservica submission packages|
|OAI-PMH Data Provider||An open, standard protocol for metadata harvesting|
|Linked Data Registry REST Services||Provides create, read, update and delete functionality for objects in the Preservica Registry|
Preservica’s REST API allows 3rd party systems to query for metadata and content stored in the archive.
Resources are accessed through a single HTTP request, using a unique URL for each resource.
The Preservica CMIS interface provides another means of accessing both metadata and content in the archive, using the open standard CMIS protocol (http://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.html) not all methods of the CMIS protocol are implemented by Preservica. Only a read-only view of the data in the archive is provided.
Preservica provides an Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH) Data Provider implementation for metadata harvesting (see http://www.openarchives.org/pmh/). This allows an external system to harvest metadata for the logical entity hierarchy in the archive, i.e. structural objects (folders) and information objects (assets).
The Linked Data Registry REST Services provide a means of accessing file format and migration pathway information from the Preservica Technical Registry.