Dokumenty
Smazat dokument
Smazat tvůj nahraný dokument spolu s jeho extrahovanými výsledky
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
}
Smaž dokument nahraný pomocí Nahrát dokument. Použij to, když
soubor nahraješ do špatného profilu. Aniva smaže soubor i všechny hodnoty, které z něj extrahovala.
Hodnoty zmizí i z aplikace Aniva daného člena.
Vyžaduje scope
documents_upload pro skupinu profilů, pod kterou byl dokument nahrán.
Aniva pak pošle webhook document.deleted na endpointy, které dostaly
poslední událost výsledků tohoto dokumentu. Smazání nelze vrátit zpět.
Požadavek
Parametry cesty
Odpověď
Při úspěchu vrátí API200 OK.
Chybové odpovědi
| Stav | Popis |
|---|---|
400 | Neplatný formát ID. |
403 | Tvůj API klíč nemá scope documents_upload. |
404 | Pod žádnou z tvých skupin profilů není nahraný dokument s tímto ID. |
500 | Interní chyba serveru. |
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
}