- Démarrage
- Exemples d’utilisation de l’API Cloud Document Understanding™ v1
- Exécution d’appels API
- Autoriser à l'aide d'une application externe et récupérer les ressources disponibles
- Utiliser les API de découverte
- utiliser les API de numérisation
- Utilisation du Data service Supprimer le document
- Licences
- Résolution des problèmes
Guide de l’API Document Understanding
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 (à l'exception des données du Moniteur) liées à un documentId donné.
Cette API vous permet de nettoyer toutes les données associées à un document sans attendre l'expiration automatique.
Supprimer les données du document
Pour déclencher la suppression de toutes les données liées à un document, utilisez l’appel suivant :
DELETE /projects/{projectId}/document/{documentId}/
DELETE /projects/{projectId}/document/{documentId}/
Les opérations de suppression sont asynchrones, ce qui signifie que la mise à jour peut ne pas s’afficher immédiatement. Veuillez patienter un instant avant de confirmer.
curl -X 'DELETE' \
'{AutomationCloudURL}/<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
}'
curl -X 'DELETE' \
'{AutomationCloudURL}/<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
}'
Lorsque vous effectuez l’appel de suppression, vous pouvez également utiliser le paramètre d’entrée facultatif suivant :
removeValidationDataFromStorage: true or false (default)
removeValidationDataFromStorage: true or false (default)
Le removeValidationDataFromStorageparamètre contrôle si les fichiers du compartiment de stockage associés sont également supprimés :
- Si la valeur est définie sur true, les fichiers associés des compartiments de stockage Orchestrator sont supprimés.
Après l'appel de suppression, un message de réponse 202 Accepté s'affiche.
Confirmer la suppression
Pour confirmer la suppression, utilisez l’appel suivant :
GET /projects/{projectId}/digitization/result/{documentId}
GET /projects/{projectId}/digitization/result/{documentId}
curl -X 'GET' \
'{AutomationCloudURL}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/digitization/result/<Document_ID>?api-version=1.1' \
-H 'accept: text/plain'
curl -X 'GET' \
'{AutomationCloudURL}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/digitization/result/<Document_ID>?api-version=1.1' \
-H 'accept: text/plain'
Une fois la suppression accomplie, un message 404 Not Found est retourné.