Dokumenty
Usuń dokument
Usuń przesłany przez ciebie dokument wraz z wyodrębnionymi z niego wynikami
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
}
Usuń dokument przesłany za pomocą Prześlij dokument. Użyj tego,
gdy plik trafił na niewłaściwy profil. Aniva usuwa plik i wszystkie wyodrębnione z niego wartości.
Wartości znikają też z aplikacji Aniva użytkownika.
Wymaga zakresu
documents_upload w grupie profili, w której przesłano dokument.
Aniva wysyła wtedy webhook document.deleted na endpointy, które odebrały
ostatnie zdarzenie z wynikami tego dokumentu. Usunięcia nie można cofnąć.
Żądanie
Parametry ścieżki
Odpowiedź
W razie powodzenia API zwraca200 OK.
Odpowiedzi z błędami
| Status | Opis |
|---|---|
400 | Nieprawidłowy format ID. |
403 | Twój klucz API nie ma zakresu documents_upload. |
404 | Żaden dokument przesłany w jednej z twoich grup profili nie ma tego ID. |
500 | Wewnętrzny błąd serwera. |
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
}