Documents
Suprimeix un document
Suprimeix un document que has pujat, juntament amb els seus resultats extrets
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
}
Suprimeix un document que hagis pujat amb Puja un document. Fes-ho servir quan
hagis pujat un fitxer al perfil equivocat. Aniva suprimeix el fitxer i tots els valors que se n’han extret.
Els valors també desapareixen de l’app d’Aniva del membre.
Requereix l’àmbit
documents_upload al grup de perfils en què es va pujar el document.
Tot seguit, Aniva envia el webhook document.deleted als punts finals que van rebre
l’últim esdeveniment de resultats del document. La supressió no es pot desfer.
Sol·licitud
Paràmetres de ruta
Resposta
En cas d’èxit, l’API retorna200 OK.
Respostes d’error
| Estat | Descripció |
|---|---|
400 | Format d’ID no vàlid. |
403 | La teva clau API no té l’àmbit documents_upload. |
404 | No hi ha cap document pujat en cap dels teus grups de perfils amb aquest ID. |
500 | Error intern del servidor. |
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
}