Konzept der edoc content services-Schnittstelle
In diesem Artikel erfahren Sie, wie Sie idealerweise die Schnittstelle zu einem Zielsystem implementieren können und welche Endpunkte in edoc content services für die Implementierung hilfreich sind.
Ermitteln des Funktionsumfangs und der notwendigen Parameter eines Zielsystems mit dem Endpunkt “/System”
Der Endpunkt /System liefert die Parameter für die Verbindungszeichenfolge (Connection String) der jeweiligen Zielsysteme. Darüber hinaus erhalten Sie den Funktionsumfang der unterstützten Zielsysteme.
Weitere Informationen finden Sie unter: Abrufen der Informationen zu den unterstützten Modulen
Ermitteln des “Bauplans” von Dokumenten und Eigenschaften mit dem Endpunkt “/Categories”
Die Kategorien bilden die Grundlage für die notwendigen Bestandteile eines Dokuments und dessen Eigenschaften. In diesem Sinne werden Kategorien als Vorlagen zum Erstellen von Dokumenten im Zielsystem verwendet. Mit dem Endpunkt /Categories erhalten Sie die Kategorien des Zielsystems. Dieser Bauplan von Dokumenten wird für die Zuordnung (Mapping) zwischen den verschiedenen Diensten und Apps benötigt. Die Zuordnung nehmen Sie dann in einem anderen Kontext vor, da in edoc content services keine Funktion für das Zuordnen der Kategorien verschiedener Systeme vorgenommen werden.
Weitere Informationen finden Sie unter: Abrufen der Kategorien eines Zielsystems
Ermitteln der vorhandenen Funktionen für Dokumente mit dem Endpunkt “/Documents”
Jedes Zielsystem bietet möglicherweise unterschiedliche Funktionalitäten im Zusammenhang mit Dokumenten an. Mit dem Endpunkt /Documents können Sie Aktionen für Dokumente für Ihr Zielsystem implementieren.
Weitere Informationen finden Sie unter: Funktionen zum Verwalten von Dokumenten (Documents)
Ermitteln der vorhandenen Funktionen für Akten mit dem Endpunkt “/Folders”
Wenn Ihr Zielsystem das Konzept “Akte” bzw. Ordner (Folder, Dossier) unterstützt, können Sie mit dem Endpunkt /Folders Aktionen für Akten oder Ordner für Ihr Zielsystem implementieren.
Weitere Informationen finden Sie unter: Funktionen zum Verwalten von Akten (Folders)
Gut zu wissen
Es gibt für jede Funktionalität eigene Endpunkte.
Wenn Sie beispielsweise die Eigenschaften eines Dokument abrufen, erhalten Sie tatsächlich nur die Eigenschaften, nicht aber die Datei selbst. Für das Abrufen der Datei steht Ihnen ein separater Endpunkt zur Verfügung.