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 die DELETE-API verwenden, um alle Runtime-Daten (mit Ausnahme der Überwachungsdaten) zu entfernen, die sich auf eine bestimmte documentId beziehen.

Mit dieser API können Sie alle zugehörigen Daten aus einem Dokument bereinigen, ohne das automatische Ablaufdatum abwarten zu müssen.

Dokumentdaten löschen

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

DELETE /projects/{projectId}/document/{documentId}/

Hinweis:

Löschvorgänge sind asynchron, was bedeutet, dass die Aktualisierung möglicherweise nicht sofort angezeigt wird. Bitte warten Sie vor der Bestätigung eine kurze Zeit.

curl -X 'DELETE' \
  'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/document/<Document_ID>/api-version=1.1' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json' \
  -d '{
  "removeValidationDataFromStorage": true
}'

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

removeValidationDataFromStorage: true or false (default)

Der removeValidationDataFromStorage Parameter steuert, ob die zugehörigen Storage-Bucket-Dateien auch gelöscht werden:

• Wenn auf true gesetzt, werden die zugehörigen Dateien aus den Orchestrator Storage-Buckets entfernt.

Nach dem Löschaufruf wird eine 202 Accepted-Antwort angezeigt.

Bestätigung des Löschvorgangs

Um das Löschen zu bestätigen, verwenden Sie folgenden Aufruf:

GET /projects/{projectId}/digitization/result/{documentId}

curl -X 'GET' \
  'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/digitization/result/<Document_ID>?api-version=1.1' \
  -H 'accept: text/plain'

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