In this topic, you will learn how you can also delete a contract deleted in the ECM system in edoc contract using the web service endpoint. When the contract is deleted in edoc contract, the active reminders are also deleted. Reminders that have already been completed are retained. Neither the deleted contract nor the associated reminders are visible in the reminder overview.
The required ECM ID can be transmitted to the web service endpoint as a JSON object (d.velop webhook) or as a parameter in the URL using the POST method.
An API key is required for authentication at the web service endpoint. You must adjust the API key in edoc automate before deploying and releasing the app.
How to customize the API key in edoc automate
-
In edoc automate, go to App details in the navigation bar and open the app variables in the workspace.
-
Replace the value of the variable rest_api.contract_delete.api_key with a new API key.
Use the following URLs to call up a web service endpoint for deleting a contract:
-
Use this URL for any ECM system: https://<app-server>/apps/ws/edoc-contract/delete-contract/<ECM-ID>
Replace the placeholder <ECM-ID> with the document ID from the ECM system (e.g. A000039803).
-
For d.velop documents use this URL: https://<app-server>/apps/ws/edoc-contract/delete-contract-webhook
Use this URL to delete a contract from the d.velop documents system. The required JSON object is automatically generated and transferred by the webhook.