Skip to main content

📘 Teamsystem Archive Documentation

Welcome to the Teamsystem Archive Documentation.

Introduction​

This documentation explains the available features and APIs offered by the Teamsystem Archive service, an integrable product through REST APIs that enables management of digital document archiving and preservation.

Authentication​

All APIs are protected by standard JWT authentication. Authentication services and their usage methods are available in the dedicated documentation section.

Main Features​

The Teamsystem Archive service exposes several API categories:

Core APIs​

The most commonly used and useful APIs for integration are:

  • Document upload: to upload new documents to the archiving system
  • Status consultation: to verify the processing and preservation status of documents
  • Configuration consultation: to access service settings and configuration

Documentation APIs​

Numerous documentation APIs are available that expose additional technical information, such as document tags, useful for understanding metadata and technical characteristics of archived documents.

Search and Distribution APIs​

The system offers specific APIs for:

  • Document search: to perform searches in the document repository
  • Distribution package generation and download: to request and download packages of preserved documents

Expiration Management APIs​

It is possible to govern the document lifecycle through expiration date management APIs, which allow control of the withdrawal date and the consequent entry into the disposal process of preserved documents.

What's Inside​

  • APIs: Learn about REST APIs, authentication, and standard headers
  • Documentation Upload APIs: Upload new documents and understand subject structure

Browse the sections in the sidebar to get started.