Utilisation du Data service Supprimer le document

Remarque :

Pour garantir un meilleur contrôle, seules les applications externes ayant l’étendue suivante peuvent accéder à ce point de terminaison : Du.Deletion.Api. Assurez-vous d’ajouter cette étendue à votre application avant de vous authentifier.

Vous pouvez utiliser l’API SUPPRIMER pour supprimer toutes les données de runtime et de validation (à l’exception des données du Moniteur) liées à un documentId donné, notamment :

• Résultats de la numérisation (Modèle d’objets de document, texte, PDF améliorés)
• Classification et résultats d’extraction
• Tâches de validation et de classification (en fonction de l’entrée de l’utilisateur)

Cette API vous permet de nettoyer toutes les données associées à un document sans attendre l’expiration automatique de sept jours.

Pour déclencher la suppression de toutes les données liées à un document, utilisez l’appel suivant :

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

Après cet appel, un message de réponse 202 Accepteds’affiche pour confirmer la demande de suppression. Pour confirmer la suppression, utilisez l’appel suivant :

GET /digitization/{documentId}

Une fois la suppression accomplie, un message 404 Not Found est retourné.

Lorsque vous effectuez l’appel de suppression, vous pouvez également utiliser le paramètre d’entrée facultatif suivant :

forceDeleteValidationData: true or false (default)

Le paramètre forceDeleteValidationData vérifie si les tâches de validation ou de classification ouvertes associées doivent également être supprimées :

• Si la valeur est définie sur true, les tâches sont supprimées et deviennent inaccessibles.
• Si la valeur est définie sur false et que des tâches sont ouvertes, l'API renvoie le message suivant :

  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”.