Abrufen der Informationen zu den unterstützten Modulen

Methode und Endpunkt	`GET /System`

Mit der Methode und dem Endpunkt GET /System können Sie die unterstützten Zielsysteme und deren unterstützten Funktionen abrufen. Außerdem erhalten Sie Informationen zum Aufbau der Verbindungszeichenfolge (Connection String).

Sie erhalten mit folgende Informationen:

ID: Gibt die ID des Zielsystems zurück. Sie müssen diese ID unbedingt bei jeder Anfrage angeben, die das Zielsystem betrifft.
Name: Gibt den Namen des Zielsystems zurück.
ConnectionStringParameter: Gibt die Namen der Parameter zurück, die Sie für die Verbindungszeichenfolge des jeweiligen Zielsystems verwenden können.
FunctionSet: Im Abschnitt FunctionSet finden Sie die von edoc content services unterstützten Funktionen für das jeweilige Zielsystem.
- SearchDocuments: Gibt an, ob die Suche nach Dokumenten unterstützt wird.
- GetCategories: Gibt an, ob das Abrufen von Kategorien unterstützt wird.
- GetDocumentProperties: Gibt an, ob das Abrufen von Dokumenteigenschaften unterstützt wird.
- StoreFile: Gibt an, ob das Hochladen einer Datei unterstützt wird.
- DeleteDocument: Gibt an, ob das Löschen eines Dokuments (Dokument und dazugehörige Datei) unterstützt wird.
- EditDocumentProperties: Gibt an, ob das Bearbeiten von Dokumenteigenschaften unterstützt wird.
- StoreDocument: Gibt an, ob das Erstellen eines Dokuments mit Eigenschaften unterstützt wird.
- DownloadFile: Gibt an, ob das Herunterladen einer Datei unterstützt wird.
- GetDocumentView: Gibt an, ob das Abrufen einer Dokumentansicht unterstützt wird.
- GetNewDocuments: Gibt an, ob das Abrufen neuer Dokumente im Zielsystem unterstützt wird.
- TestConnection: Gibt an, ob das Testen der Verbindung zu einem Zielsystem unterstützt wird.
- StoreMetaData: Gibt an, ob das Speichern von Eigenschaften zu einem Dokument unterstützt wird.
- GetFolderById: Gibt an, ob das Abrufen einer Akte anhand ihrer ID unterstützt wird.
- CreateFolder: Gibt an, ob das Erstellen einer Akte unterstützt wird.
- EditFolder: Gibt an, ob das Editieren einer Akte unterstützt wird.
- SearchFolder: Gibt an, ob das Suchen nach Akten unterstützt wird.
- GetFoldersStructure: Gibt an, ob das Abrufen der Aktenstruktur unterstützt wird.
- DeleteFolder: Gibt an, ob das Löschen einer Akte unterstützt wird.

Beispiel für einen Request

CODE

GET /System
Accept: application/json

Als Antwort erhalten Sie boolesche Werte:

Der Wert true bedeutet, dass die Funktion unterstützt wird.
Derr Wert false bedeutet, dass die Funktion nicht unterstützt wird.

Beispiel für einen Response

JSON

{
  "modules": [
    {
      "id": "d3",
      "name": "d.velop d.3ecm",
      "connectionStringParameter": [
        "targethost",
        "user",
        "password",
        "repositoryid"
      ],
      "functionSet": {
        "searchDocuments": true,
        "getCategories": true,
        "getDocumentProperties": true,
        "storeFile": true,
        "deleteDocument": true,
        "editDocumentProperties": true,
        "storeDocument": true,
        "downloadFile": true,
        "getDocumentView": true,
        "getNewDocuments": true,
        "testConnection": true,
        "storeMetaData": true,
        "getFolderById": true,
        "createFolder": true,
        "editFolder": true,
        "searchFolder": true,
        "getFoldersStructure": true,
        "deleteFolder": true
      }
    },
    {
      "id": "d3one",
      "name": "d.velop documents",
      "connectionStringParameter": [
        "targethost",
        "apikey",
        "repositoryid"
      ],
      "functionSet": {
        "searchDocuments": false,
        "getCategories": true,
        "getDocumentProperties": true,
        "storeFile": true,
        "deleteDocument": true,
        "editDocumentProperties": true,
        "storeDocument": true,
        "downloadFile": true,
        "getDocumentView": true,
        "getNewDocuments": true,
        "testConnection": true,
        "storeMetaData": true,
        "getFolderById": true,
        "createFolder": true,
        "editFolder": true,
        "searchFolder": true,
        "getFoldersStructure": true,
        "deleteFolder": true
      }
    },
    {
      "id": "sharepoint",
      "name": "SharePoint",
      "connectionStringParameter": [
        "targethost",
        "user",
        "password",
        "listid"
      ],
      "functionSet": {
        "searchDocuments": false,
        "getCategories": true,
        "getDocumentProperties": true,
        "storeFile": true,
        "deleteDocument": true,
        "editDocumentProperties": true,
        "storeDocument": true,
        "downloadFile": true,
        "getDocumentView": true,
        "getNewDocuments": true,
        "testConnection": true,
        "storeMetaData": true,
        "getFolderById": true,
        "createFolder": true,
        "editFolder": true,
        "searchFolder": false,
        "getFoldersStructure": true,
        "deleteFolder": true
      }
    },
    {
      "id": "eds",
      "name": "edoc documents",
      "connectionStringParameter": [
        "targethost",
        "apikey"
      ],
      "functionSet": {
        "searchDocuments": false,
        "getCategories": true,
        "getDocumentProperties": true,
        "storeFile": true,
        "deleteDocument": true,
        "editDocumentProperties": true,
        "storeDocument": true,
        "downloadFile": true,
        "getDocumentView": false,
        "getNewDocuments": false,
        "testConnection": true,
        "storeMetaData": true,
        "getFolderById": false,
        "createFolder": false,
        "editFolder": false,
        "searchFolder": false,
        "getFoldersStructure": false,
        "deleteFolder": false
      }
    }
  ]
}