Перейти к основному содержанию
GET
Прочитай статус и лабораторные значения документа, загруженного через Загрузку документа. Ответ имеет ту же структуру, что и Получение результатов анализов для записи. Все поля смотри в Результатах. Ответ возвращается только для документов, загруженных в группу профилей, из которой твой ключ может читать результаты. Для всех остальных документов возвращается 404: их результаты читай через запись или заказ набора для домашнего теста, по которому они получены. Постоянно опрашивать API не нужно. Подпишись на вебхуки document.results.updated или document.results.completed и вызывай этот эндпоинт при получении события. Требуется разрешение results_view для группы профилей, в которую был загружен документ.

Запрос

Параметры пути

string
обязательно
ID документа (UUID) из ответа на загрузку.

Заголовки

string
Значение ETag из предыдущего ответа. Если ничего не изменилось, API ответит 304 Not Modified без тела.

Ответ

При успехе API возвращает 200 OK с объектом результатов и заголовком ETag.
string
обязательно
Одно из значений:
  • in_progress — Aniva извлекает значения.
  • completed — извлечение завершено.
  • fault — ошибка извлечения.
  • stored — в документе нет значений: он загружен без extract_results или не содержит лабораторных результатов. Статус stored окончательный: вебхук document.results.completed не придет.
object[]
обязательно
Извлеченные значения. У каждого значения указано origin: partner_upload. Если в отчете несколько дат сдачи образцов, каждое значение получает свое tested_at. Статуса planned не бывает: загрузка ничего не заказывает.
object[]
обязательно
Генетические результаты. Для загруженного документа сейчас пусто.
object[]
обязательно
Сам загруженный документ.
object[]
обязательно
Один элемент для этой загрузки. lab_code равен null.

Ответы с ошибками