API v1Скачать текст отчёта или PDF

Скачать текст отчёта или PDF

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

GET/runs/{run_id}/report

По умолчанию возвращает Markdown. Для PDF передайте format=pdf. Фильтр section требует format=pdf. Отчёт по разделу сохраняет номера замечаний общего отчёта.

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

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

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

GET /runs/{run_id}/report

curl --fail-with-body "$NK_BASE/runs/$RUN_ID/report" \
  -H "Authorization: Bearer $NK_KEY" \
  --output report.pdf

Параметры

Параметр	Где / тип	Обязательный	Описание
`run_id`	Путь строка	Да	Используйте идентификатор вашей организации. Идентификатор из ответа API.
`format`	Запрос строка	Нет	По умолчанию md. Формат документа. Значения: "md", "pdf". По умолчанию: "md".
`section`	Запрос строка	Нет	Только PDF. Не совмещайте с theme. Используйте лишь код, подтверждённый этим отчётом. Код раздела из available_sections, например ЭОМ.
`theme`	Запрос строка	Нет	Требует тематической разметки отчёта. не совмещайте с section. Широкая тематическая группа. Значения: "norms", "construction", "engineering", "unassigned".

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

`200`

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

text/markdown

application/pdf

`400`

Неверные параметры запроса или комплект не принят.

application/json

Поля ответа

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

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

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

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

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

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

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

`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объект · необязательное: Переданное значение.

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

`409`

Конфликт версии или метки отправки. Возможная причина для отчёта: нет привязки к запрошенному разделу.

application/json

Поля ответа

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

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

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

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

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

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

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

`503`

API/подключение/PDF временно недоступны.

application/json

Поля ответа

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

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

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

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

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

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

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

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

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