In this article you will learn about the special features and characteristics of the module d.velop d.3ecm-API (deprecated) (ID=d3) in edoc content services. You use the module whenever you want to use functions in connection with d.3 server (d.velop documents (on-premises)).
The d.3 API has been discontinued by d.velop and is no longer supported. You can use the edoc content services module d.velop documents instead. If you have any questions, please get in touch with your edoc contact.
API of the "d.velop d.3ecm-API (deprecated)" module
The module uses the d.3 API interface, also known as Java API, for communication with the d.velop ECM system.
The d3-rest-api service, which is automatically delivered with edoc content services, is used for communication between the d.3 API. The d3-rest-api service is a PHP wrapper that provides a REST API for the JavaBridge.jar file.
The d3-rest-api service has its own Swagger user interface. The URL to Swagger for d3-rest-api depends on the respective installation. You can also search for solutions to problems in Swagger.
Authentication method used in the "d.velop d.3ecm-API (deprecated)" module
The d.3 API only supports the standard authentication Basic Auth (Basic Authentication), i.e. a login with user name and password.
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.
Filter by category when searching for documents
If you use the module d.velop d.3ecm-API (deprecated), you can filter by the category of documents in the search for documents. To filter by category, add a search criterion with the key doc_type_short and the ID of the category as value in the request.
POST /Doucments/search
Accept: application/json
ModuleId: d3
{
"doc_type_short": "BANFP",
"doc_field[6]": "4485644",
"doc_field[10]": "edoc solutions ag"
}