Dokumentumok
Dokumentum törlése
Egy általad feltöltött dokumentum törlése a kinyert eredményekkel együtt
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
}
Törölj egy dokumentumot, amelyet a Dokumentum feltöltése segítségével
töltöttél fel. Akkor használd, ha rossz profilhoz töltöttél fel egy fájlt. Az Aniva törli a fájlt és
minden belőle kinyert értéket. Az értékek a tag Aniva alkalmazásából is eltűnnek.
A
documents_upload scope szükséges hozzá annál a profilcsoportnál, amely alá a dokumentumot feltöltötték.
Az Aniva ezután elküldi a document.deleted webhookot azoknak a végpontoknak,
amelyek a dokumentum utolsó eredményeseményét megkapták. A törlés nem vonható vissza.
Kérés
Útvonalparaméterek
Válasz
Siker esetén az API200 OK választ ad vissza.
Hibaválaszok
| Státusz | Leírás |
|---|---|
400 | Érvénytelen azonosítóformátum. |
403 | Az API-kulcsodból hiányzik a documents_upload scope. |
404 | Egyetlen profilcsoportod alá feltöltött dokumentumnak sincs ilyen azonosítója. |
500 | Belső szerverhiba. |
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
}