API v1Получить замечания и уточнения в JSON

Получить замечания и уточнения в JSON

Обновлено 8 октября 2026

GET/runs/{run_id}/findings

questions не входят в counts.total. Если parsed равен false, используйте raw_markdown. available_sections содержит доступные отчёты по разделам. Если поля нет, используйте общий PDF.

Передайте ключ организации в заголовке Authorization: Bearer <ключ>.

Пример запроса

Используйте NK_BASE и NK_KEY из быстрого старта. Переменные в пути, например RUN_ID, замените значениями из ваших ответов API.

GET /runs/{run_id}/findings

curl --fail-with-body "$NK_BASE/runs/$RUN_ID/findings" \
  -H "Authorization: Bearer $NK_KEY"

Параметры

Параметр	Где / тип	Обязательный	Описание
`run_id`	Путь строка	Да	Используйте идентификатор вашей организации. Идентификатор из ответа API.

Ответы и ошибки

`200`

Успешный ответ.

application/json

Поля ответа

run_idстрока · обязательное

Номер проверки.

parsedда / нет · обязательное

Удалось ли разобрать отчёт на поля.

findingsмассив: объект · обязательное

Замечания.

Вложенные поля

Массив элементов:

nцелое число · обязательное: Видимый номер пункта. в отчёте по разделу не перенумеровывается.
finding_idстрока · необязательное: Идентификатор для записи решения специалиста.
candidate_idстрока / null · необязательное: Идентификатор исходного пункта, если доступен.
statusстрока / null · необязательное: Статус пункта отчёта. Отличается от status всей проверки.
importanceстрока / null · необязательное: Уровень важности. Набор текстовых значений может расширяться.
essenceстрока / null · обязательное: Суть замечания.
evidence_textстрока · обязательное: Доказательство, цитаты и ссылки.
actionстрока / null · обязательное: Что предлагается сделать.
sectionстрока · необязательное: Раздел документации, например ЭОМ. Пункт по нескольким разделам может содержать АР/КР.
albumстрока · необязательное: Том/альбом, если указан.
stageстрока · необязательное: Стадия документации, если указана.
topicстрока / null · необязательное: Широкая тематическая группа. Значения: "norms", "construction", "engineering", "unassigned", null.
pagesмассив: целое число · необязательное: Вложенные поля
Массив элементов:
page_refsмассив: объект · необязательное: Вложенные поля
Массив элементов:
sourcesмассив: объект · необязательное: Вложенные поля
Массив элементов:
reference_problemsмассив: строка · необязательное: Вложенные поля
Массив элементов:

questionsмассив: объект · необязательное

Уточнения, отдельно от замечаний.

Вложенные поля

Массив элементов:

nцелое число · обязательное: Видимый номер пункта. в отчёте по разделу не перенумеровывается.
candidate_idстрока / null · необязательное: Идентификатор исходного пункта, если доступен.
statusстрока / null · необязательное: Статус пункта отчёта. Отличается от status всей проверки.
importanceстрока / null · необязательное: Уровень важности. Набор текстовых значений может расширяться.
essenceстрока / null · обязательное: Суть замечания.
evidence_textстрока · обязательное: Доказательство, цитаты и ссылки.
actionстрока / null · обязательное: Что предлагается сделать.
sectionстрока · необязательное: Раздел документации, например ЭОМ. Пункт по нескольким разделам может содержать АР/КР.
albumстрока · необязательное: Том/альбом, если указан.
stageстрока · необязательное: Стадия документации, если указана.
topicстрока / null · необязательное: Широкая тематическая группа. Значения: "norms", "construction", "engineering", "unassigned", null.
pagesмассив: целое число · необязательное: Вложенные поля
Массив элементов:
page_refsмассив: объект · необязательное: Вложенные поля
Массив элементов:
sourcesмассив: объект · необязательное: Вложенные поля
Массив элементов:
reference_problemsмассив: строка · необязательное: Вложенные поля
Массив элементов:

countsобъект · обязательное

Общее число и распределение по важности.

Вложенные поля

totalцелое число · необязательное: Всего замечаний, без questions.

available_sectionsмассив: объект · необязательное

Доступные отчёты по разделам. Если поле отсутствует или пусто, используйте общий PDF. Пункт по нескольким разделам может входить в каждый соответствующий отчёт.

Вложенные поля

Массив элементов:

codeстрока · обязательное: Код для параметра section.
findingsцелое число · обязательное: Число замечаний отчёта.

format_versionцелое число · необязательное

Версия формата отчёта, если указана.

objectобъект · необязательное

Вложенные поля

addressстрока / null · необязательное: Адрес объекта, если установлен.
worksстрока / null · необязательное: Наименование работ, если установлено.

summaryобъект · необязательное

Вложенные поля

kratkoстрока / null · необязательное: Краткое содержание.
itogстрока / null · необязательное: Итог.

sectionsмассив: объект · необязательное

Вложенные поля

Массив элементов:

titleстрока · необязательное: Название дополнительного раздела.
markdownстрока · необязательное: Содержимое в Markdown.

raw_markdownстрока · необязательное

Исходный текст опубликованного отчёта.

problemsмассив: строка · необязательное

Вложенные поля

Массив элементов:

Проблема разбора.

reference_problemsмассив: строка · необязательное

Вложенные поля

Массив элементов:

Проблема ссылок.

warningsмассив: строка · необязательное

Вложенные поля

Массив элементов:

Ограничение/предупреждение по результату.

user_requestстрока · необязательное

Сохранённое задание клиента.

bundleобъект / null · необязательное

Вложенные поля

bundle_idстрока · необязательное: Именованный комплект/проект.
revision_idстрока · необязательное: Версия состава файлов.
labelстрока · необязательное: Название комплекта.

null

feedback_snapshotстрока · необязательное

Версия для отправки feedback.

feedback_actorстрока · необязательное

Автор интеграции. Используйте его для поиска своей версии решения.

feedbackмассив: объект · необязательное

Вложенные поля

Массив элементов:

feedback_idстрока · обязательное: Номер события решения.
run_idстрока · необязательное: Проверка.
tenant_idстрока · необязательное: Организация.
snapshotстрока · обязательное: Версия результата.
finding_idстрока · обязательное: Замечание.
actorстрока · необязательное: Автор интеграции, определяется ключом доступа.
decisionстрока · обязательное: accepted — одобрено. rejected — отклонено. withdrawn — отозвано. Значения: "accepted", "rejected", "withdrawn".
reasonстрока · необязательное: Комментарий.
versionцелое число · обязательное: Версия решения. Первое сохранённое решение имеет версию 1.
request_keyстрока · необязательное: Метка отправки решения.
created_atстрока · необязательное: Время решения.
reason_codeстрока / null · необязательное: Код причины отклонения в подключениях с расширенной обратной связью.
employee_idстрока / null · необязательное: Ответственный сотрудник, если назначен.

employeesмассив: объект · необязательное

Вложенные поля

Массив элементов:

employee_idстрока · обязательное: Идентификатор сотрудника.
nameстрока · обязательное: Имя сотрудника.
disciplinesмассив: строка · обязательное: Разделы, за которые отвечает сотрудник.
Вложенные поля
Массив элементов:
created_atстрока · необязательное: Время создания.

usageобъект · необязательное

Вложенные поля

prompt_tokensцелое число · необязательное: Учтённые входные токены.
completion_tokensцелое число · необязательное: Учтённые выходные токены.
cost_rubчисло · необязательное: Учтённая стоимость обработки. Не заменяет счёт клиенту. Ноль не означает бесплатную проверку.

`401`

Ключ не передан, неверен или отозван.

application/json

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.

`403`

Доступ закрыт или действие не разрешено.

application/json

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.

`404`

Объект не найден, результат ещё не опубликован либо дополнительный метод недоступен в подключении.

application/json

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.

`Другой ответ`

Ошибка входного сервера или сети может иметь текстовое/HTML-тело. Проверяйте HTTP-статус и Content-Type.