Retrieve information on the supported modules

Method and endpoint	`GET /System`

You can use the GET /System method and endpoint to retrieve the supported destination systems and their supported functions. You also receive information on the structure of the connection string.

You will receive the following information:

ID: Returns the ID of the destination system. You must specify this ID for every request relating to the destination system.
Name: Returns the name of the destination system.
ConnectionStringParameter: Returns the names of the parameters that you can use for the connection string of the respective destination system.
FunctionSet: In the FunctionSet section, you will find the functions supported by edoc content services for the respective destination system.
- SearchDocuments: Specifies whether the search for documents is supported.
- GetCategories: Specifies whether the retrieval of categories is supported.
- GetDocumentProperties: Specifies whether the retrieval of document properties is supported.
- StoreFile: Specifies whether uploading a file is supported.
- DeleteDocument: Specifies whether the deletion of a document (document and associated file) is supported.
- EditDocumentProperties: Specifies whether the editing of document properties is supported.
- StoreDocument: Specifies whether the creation of a document with properties is supported.
- DownloadFile: Specifies whether downloading a file is supported.
- GetDocumentView: Specifies whether the retrieval of a document view is supported.
- GetNewDocuments: Specifies whether the retrieval of new documents is supported in the destination system.
- TestConnection: Specifies whether testing of the connection to a destination system is supported.
- StoreMetaData: Specifies whether the saving of properties for a document is supported.
- GetFolderById: Specifies whether the retrieval of a file by its ID is supported.
- CreateFolder: Specifies whether the creation of a file is supported.
- EditFolder: Specifies whether editing of a file is supported.
- SearchFolder: Specifies whether searching for files is supported.
- GetFoldersStructure: Specifies whether the retrieval of the file structure is supported.
- DeleteFolder: Specifies whether the deletion of a file is supported.

Example of a request

GET /System
Accept: application/json

You will receive Boolean values in response:

The value true means that the function is supported.
The value false means that the function is not supported.

Example of a response

JSON

{
  "modules": [
    {
      "id": "d3",
      "name": "d.velop d.3ecm-API (deprecated)",
      "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, d.velop cloud (REST-API)",
      "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": "Microsoft SharePoint (OData, REST-API v.1)",
      "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
      }
    }
  ]
}