Löschen eines Vertrags in edoc contract mit der REST-API

In diesem Thema erfahren Sie, wie Sie einen im ECM-System gelöschten Vertrag mithilfe des Webservice-Endpunkts ebenfalls in edoc contract löschen können. Mit dem Löschen des Vertrags in edoc contract werden auch die aktiven Reminder gelöscht. Bereits erledigte Reminder bleiben erhalten. In der Reminderübersicht sind weder der gelöschte Vertrag noch die zugehörigen Reminder sichtbar.

Die benötigte ECM-ID kann als JSON-Objekt (d.velop-Webhook) oder als Parameter in der URL mittels der POST-Methode an den Webservice-Endpunkt übermittelt werden.

Zum Authentifizieren am Webservice-Endpunkt wird ein API-Schlüssel benötigt. Den API-Schlüssel müssen Sie vor dem Bereitstellen (Deployment) und Release der App in edoc automate anpassen.

So passen Sie den API-Schlüssel in edoc automate an

1. Gehen Sie in edoc automate in der Navigationsleiste auf App-Details und öffnen Sie im Arbeitsbereich die App-Variablen.

2. Ersetzen Sie den Wert der Variablen rest_api.contract_delete.api_key durch einen neuen API-Schlüssel (API key).

Mit den folgenden URLs rufen Sie einen Webservice-Endpunkt zum Löschen eines Vertrages auf:

• Für ein beliebiges ECM-System verwenden Sie diese URL: https://<app-server>/apps/ws/edoc-contract/delete-contract/<ECM-ID>

Ersetzen Sie den Platzhalter <ECM-ID> durch die Dokument-ID aus dem ECM-System (z.B. A000039803).

• Für d.velop documents verwenden Sie diese URL: https://<app-server>/apps/ws/edoc-contract/delete-contract-webhook

Verwenden Sie diese URL, um aus dem d.velop documents-System einen Vertrag zu löschen. Das benötigte JSON-Objekt wird vom Webhook automatisch erzeugt und übergeben.