Documents
Supprimer un document
Supprimer un document que tu as importé, ainsi que ses résultats extraits
DELETE
/
api
/
v1
/
documents
/
{id}
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
Supprime un document que tu as importé avec Importer un document. Utilise cet endpoint quand
tu as importé un fichier sur le mauvais profil. Aniva supprime le fichier et toutes les valeurs qui en ont été extraites.
Les valeurs disparaissent aussi de l’application Aniva du membre.
Nécessite le scope
documents_upload sur le groupe de profils dans lequel le document a été importé.
Aniva envoie ensuite le webhook document.deleted aux endpoints qui ont reçu
le dernier événement de résultats du document. Une suppression ne peut pas être annulée.
Requête
Paramètres de chemin
Réponse
En cas de succès, l’API renvoie200 OK.
Réponses d’erreur
| Statut | Description |
|---|---|
400 | Format d’ID invalide. |
403 | Ta clé API ne dispose pas du scope documents_upload. |
404 | Aucun document importé dans l’un de tes groupes de profils ne porte cet ID. |
500 | Erreur interne du serveur. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}