PREVIEW

Verwenden Sie den Data Service zum Löschen von Dokumenten

Hinweis:

Für eine bessere Kontrolle können nur externe Anwendungen mit folgendem Umfang auf diesen Endpunkt zugreifen:Du.Deletion.ApiStellen Sie sicher, dass Sie diesen Umfang Ihrer Anwendung vor der Authentifizierung hinzufügen.

Sie können mithilfe der DELETE API alle Runtime- und Validierungsdaten (außer Überwachungsdaten) für eine bestimmte documentIdInstanz entfernen, einschließlich:

• Digitalisierungsergebnisse (Dokumentenobjektmodell, Text, optimierte PDFs)
• Klassifizierung und Extraktionsergebnisse
• Validierungs- und Klassifizierungsaufgaben (basierend auf Benutzereingaben)

Über diese API können Sie alle zugehörigen Daten aus einem Dokument bereinigen, ohne das automatische Ablaufdatum von sieben Tagen abwarten zu müssen.

Um das Löschen aller mit einem Dokument verknüpften Daten zu initiieren, verwenden Sie folgenden Aufruf:

POST /projects/{projectId}/document/{documentId}/

Nach diesem Aufruf wird eine Antwortmeldung 202 Accepted als Bestätigung der Löschanfrage angezeigt. Um das Löschen zu bestätigen, verwenden Sie folgenden Aufruf:

GET /digitization/{documentId}

Nach Abschluss des Löschvorgangs wird eine Meldung 404 Not Found zurückgegeben.

Sie können auch mithilfe des folgenden optionalen Eingabeparameter den Löschaufruf ausführen:

forceDeleteValidationData: true or false (default)

Der Parameter forceDeleteValidationData steuert, ob die zugehörigen offenen Validierungs- oder Klassifizierungsaufgaben ebenfalls gelöscht werden sollen:

• Wenn auf der Wert auf true gesetzt ist, werden die Aufgaben gelöscht und sind nicht mehr zugänglich.
• Wenn false festgelegt ist und offene Aufgaben vorhanden sind, gibt die API die folgende Meldung zurück:

  403 Forbidden
  Cannot delete document with ID {documentId}, as it has open validation tasks – either complete the created tasks or set the forceDeleteValidationData option to “true”.