In this article you will learn about the special features and characteristics of the module d.velop documents, d.velop cloud (REST-API)(ID=d3one) in edoc content services. You use the module whenever you want to use functions in connection with d.velop documents (cloud and on-premises (AKA d.3one)).
Authentication method used in the "d.velop documents, d.velop cloud (REST-API)" module
d.velop documents offers a REST API that works with the Open Authorization 2 protocol (OAuth2). You need to create an API key in d.ecs identity provider. For more information about the authentication methods, please refer to the corresponding d.velop documentation for the d.velop infrastructure components of d.velop documents.
What happens during the "ConnectionTest" action?
If you address the GET /ConnectionTest endpoint, a login to the module is performed and a search for a fictitious document is started. This ensures that both the user and password parameters as well as the repositoryid parameter are correct.
Automatic release when changing document properties
If a document has the status Processing, the properties cannot be changed. To avoid this problem, documents in the Processing status are first released automatically and then their properties are changed.
Things to know about filtering the d.velop documents-IDs on-premises
Starting with the Annual 2025 version, d.velop documents on-premises returns two different types of IDs for document properties and categories simultaneously when retrieving data: Legacy IDs and UUIDs.
Example for the returned d.velop IDs (ID in legacy format and UUID)
// legacy
{
"key": "6",
"value": "sample record 1"
}
// uuid
{
"key": "4ce20af2-4926-4a72-b219-77eba975b247",
"value": "sample record 1"
}
For the mapping in edoc content services to work correctly, the IDs must be consistent. You must specify which d.velop ID type is to be used.
There are two settings to control the filtering of the d.velop documents IDs:
-
In the configuration of the DMS app of d.velop documents with the parameter Feature.UseUUIDsForMapping.
-
In edoc content services with the idmapping parameter in the connection string.
Both settings must match so that the same ID type is always returned.
Specify the "idmapping" parameter in the connection string
For connections with d.velop documents on-premises, you can add the parameter idmapping in the connection string to filter the data records for your system.
Use the idmapping parameter to specify which type of d.velop IDs is used: Legacy IDs (e.g. 6) or UUIDs, e.g. 4ce20af2-4926-4a72-b219-77eba975b247.
By default, the idmapping parameter is not defined in the connection string. As of version Annual 2025 of d.velop documents, you must define the idmapping parameter so that the mapping works correctly.
The setting must match the setting for the parameter Feature.UseUUIDsForMapping in the configuration of the DMS app of d.velop documents: Connection with the parameter "Feature.UseUUIDsForMapping" in d.velop documents
The following options are available for the idmapping parameter in edoc content services:
-
idmapping=legacy: The parameter returns the IDs in the structure specified by the d.velop documents system, e.g. 6.
-
idmapping=uuid: The parameter returns the IDs in UUID format.
-
idmapping=null (or not specified): The records are not filtered by ID type. The returned data may contain legacy IDs and UUIDs, depending on the settings in your d.velop documents system.
The settings depend on the further processing in your system.
Connection between the parameter "Feature.UseUUIDsForMapping" in d.velop documents and the parameter "idmapping"
The parameter idmapping in edoc content services must match the setting for the parameter Feature.UseUUIDsForMapping in the configuration of the DMS app of d.velop documents:
-
Feature.UseUUIDsForMapping=true: Use the value uuid in the connection string for idmapping, i.e. idmapping=uuid.
-
Feature.UseUUIDsForMapping=false: Use the value legacy in the connection string for idmapping, i.e. idmapping=legacy.
For example, if you only want to use legacy IDs, you have to set the parameter Feature.UseUUIDsForMapping in the d.velop documents configuration to false.
Here's how
-
Open the configuration of the DMS app (d.3one DMSApp Configuration) from d.velop documents at https://<d3one-host>/dms/config.
-
In the Parameter name field, add the parameter Feature.UseUUIDsForMapping.
-
Set the value of the parameter to false.
-
Click on Empty cache (broom symbol).
Search for documents
If you use the module d.velop documents, d.velop cloud (REST-API), you can filter by the category of documents when searching for documents.
To filter by category, add a search criterion in the request with the key category and the ID of the category as the value.
POST /Doucments/search
Accept: application/json
ModuleId: d3one
{
"category": "e09c63de-e217-44a8-957c-0c6e6c936d0c",
"5f28b031-399f-42e2-885b-093b3f7b66aa": "4485644",
"1623f20a-7f1d-40a9-b208-65db622c5b2c": "edoc solutions gmbh"
}
With the module d.velop documents, d.velop cloud (REST-API) you can also search for documents without specifying a category. If you search for documents without a category, the filter properties must be available in all categories.