edoc content services Guide
Breadcrumbs

Concept of the edoc content services interface

In this article, you will learn how you can ideally implement the interface to a destination system and which endpoints in edoc content services are helpful for the implementation.

Determine the functional scope and the necessary parameters of a destination system with the endpoint "/System"

The /System endpoint provides the parameters for the connection string of the respective destination systems. You also receive the range of functions of the supported destination systems.

For more information, see: Retrieve information on the supported modules

Determine the "blueprint" of documents and properties with the "/Categories" endpoint

The categories form the basis for the necessary components of a document and its properties. In this sense, categories are used as templates for creating documents in the destination system. The /Categories endpoint provides you with the categories of the destination system. This blueprint of documents is required for mapping between the various services and apps. You then carry out the mapping in a different context, as edoc content services does not have a function for mapping the categories of different systems.

For more information, see: Retrieve the categories of a destination system

Determine the existing functions for documents with the endpoint "/Documents"

Each destination system may offer different functionalities in connection with documents. You can use the /Documents endpoint to implement actions for documents for your destination system.

For more information, see: Functions for managing documents

Determine the existing functions for files with the endpoint "/Folders"

If your destination system supports the concept "file" or folder (dossier), you can implement actions for files or folders for your destination system with the /Folders endpoint.

For more information, see: Functions for managing files (folders)

Things to know

There are separate endpoints for each functionality.

For example, if you retrieve the properties of a document, you actually only receive the properties, but not the file itself. A separate endpoint is available for retrieving the file.