Главная / Документация / APIAPI: контроль качестваМаршруты контроля качества проекта в volrix.pm: документы ПКК по этапам, согласующие, готовность этапа, RACI и мастер создания проекта.Обновлено 27.09.2026Контроль качества (ПКК) - перечень документов, которые проект должен подготовить и согласовать на каждом этапе. Для каждого документа задаются этап, обязательность и согласующие (конкретный сотрудник или роль). По перечню сервер считает готовность этапа и матрицу RACI.**Что принимает API-ключ.** Только мастер создания проекта POST /projects/wizard (projects:create). Остальные маршруты проверяют участие в проекте и работают в сессии пользователя. Файлы документов загружаются через документы проекта (Документы, письма, договоры), согласование идет заявкой с target_type qc_document (Согласования).Базовый адрес, формат ответов и коды ошибок описаны в статье API: адрес, первый запрос и ответы, выпуск ключа и вход под пользователем - в статье API: вход, токен и API-ключи. В примерах ключ лежит в переменной окружения VOLRIX_API_KEY, токен пользователя - в VOLRIX_TOKEN.Типовой сценарий

Создайте проект с перечнем POST /api/v1/projects/wizard с телом WizardRequest: project (обязательны name, customer_id, start_date, end_date, pm_id, eol_id, document_set_id) и qc_documents.

Добавьте документы этапа POST .../quality-control/apply-stage-defaults?stage_id=... - перечень по умолчанию для этапа; отдельный документ - POST .../quality-control с телом QCDocumentCreate.

Назначьте согласующих POST .../quality-control/{qc_id}/approvers с телом QCApproverInput: approver_type role или employee. Подсказку дает GET .../quality-control/suggested-approvers?task_id=....

Проверьте готовность GET /api/v1/projects/{project_id}/stage-readiness перед сменой этапа. Этап готов, когда задачи-вехи всех его документов в статусе completed; ответ перечисляет незакрытые документы. Этапы без документов ПКК в ответ не попадают.

Примеры запросовПеречень документов ПКК проекта (сессия):curl --fail-with-body -sS \ -H "Authorization: Bearer $VOLRIX_TOKEN" \ "https://ваш-адрес/api/v1/projects/{project_id}/quality-control"Новый обязательный документ этапа с согласующей ролью (сессия):curl --fail-with-body -sS -X POST \ -H "Authorization: Bearer $VOLRIX_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name": "Протокол испытаний", "stage_id": "...", "is_required": true, "approvers": [{"approver_type": "role", "role_code": "..."}]}' \ "https://ваш-адрес/api/v1/projects/{project_id}/quality-control"МаршрутыКак читать колонку «Доступ»: **скоуп вида users:read** - маршрут принимает API-ключ, если в ключе есть этот скоуп, а у сотрудника, выпустившего ключ, есть такое же право в роли (users.read). Если скоупов несколько через «+», нужны все. **Только сессия** - нужен заголовок Authorization: Bearer, API-ключ получит 403. **Без авторизации** - заголовки не нужны. Доступ к конкретному объекту (участие в проекте, права на папку Диска) сервер проверяет дополнительно. Пути в таблицах указаны полностью, от корня сервера.Мастер создания проекта

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

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

POST /api/v1/projects/wizard

Нет | Тело: application/json: WizardRequest

projects:create

201: WizardResponse

Документы контроля качества

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

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

GET /api/v1/projects/{project_id}/quality-control

project_id [path обяз.]: string (uuid)

Только сессия

200: array[QCDocumentRead]

POST /api/v1/projects/{project_id}/quality-control

project_id [path обяз.]: string (uuid) | Тело: application/json: QCDocumentCreate

Только сессия

201: QCDocumentRead

GET /api/v1/projects/{project_id}/stage-readiness

project_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/projects/{project_id}/raci

project_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/projects/{project_id}/quality-control/apply-stage-defaults

project_id [path обяз.]: string (uuid); stage_id [query]: string (uuid) / null

Только сессия

200: object

GET /api/v1/projects/{project_id}/quality-control/{qc_id}/printform

project_id [path обяз.]: string (uuid); qc_id [path обяз.]: string (uuid)

Только сессия

200: object

PUT /api/v1/projects/{project_id}/quality-control/{qc_id}

project_id [path обяз.]: string (uuid); qc_id [path обяз.]: string (uuid) | Тело: application/json: QCDocumentUpdate

Только сессия

200: QCDocumentRead

DELETE /api/v1/projects/{project_id}/quality-control/{qc_id}

project_id [path обяз.]: string (uuid); qc_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/projects/{project_id}/quality-control/{qc_id}/approvers

project_id [path обяз.]: string (uuid); qc_id [path обяз.]: string (uuid) | Тело: application/json: QCApproverInput

Только сессия

201: QCApproverRead

PUT /api/v1/projects/{project_id}/quality-control/{qc_id}/approvers/{approver_id}

project_id [path обяз.]: string (uuid); qc_id [path обяз.]: string (uuid); approver_id [path обяз.]: string (uuid) | Тело: application/json: QCApproverInput

Только сессия

200: QCApproverRead

DELETE /api/v1/projects/{project_id}/quality-control/{qc_id}/approvers/{approver_id}

project_id [path обяз.]: string (uuid); qc_id [path обяз.]: string (uuid); approver_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/projects/{project_id}/quality-control/suggested-approvers

project_id [path обяз.]: string (uuid); task_id [query обяз.]: string (uuid)

Только сессия

200: object

Тела запросовПоля JSON и форм multipart из схемы сервера. «Да» - поле обязательно. Ссылка на другую схему (например, array[QCApproverInput]) означает вложенный объект с теми же полями.WizardRequest: POST /projects/wizard

Поле

Обязательно

Тип / значения

Ограничения

project

Да

WizardProjectBase

qc_documents

Нет

array[QCDocumentCreate]

default=[]

QCDocumentCreate: POST /projects/{project_id}/quality-control

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

minLength=1; maxLength=500

description

Нет

string / null

stage_id

Нет

string (uuid) / null

document_kind_id

Нет

string (uuid) / null

is_required

Нет

boolean

default=true

sort_order

Нет

integer

default=0

approvers

Нет

array[QCApproverInput]

default=[]

QCDocumentUpdate: PUT /projects/{project_id}/quality-control/{qc_id}

Поле

Обязательно

Тип / значения

Ограничения

name

Нет

string / null

description

Нет

string / null

stage_id

Нет

string (uuid) / null

sort_order

Нет

integer / null

QCApproverInput: POST /projects/{project_id}/quality-control/{qc_id}/approvers, PUT /projects/{project_id}/quality-control/{qc_id}/approvers/{approver_id}

Поле

Обязательно

Тип / значения

Ограничения

approver_type

Да

string: role, employee

employee_id

Нет

string (uuid) / null

role_code

Нет

string / null

is_required

Нет

boolean

default=true

sort_order

Нет

integer

default=0

Вложенный объект WizardProjectBase

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

minLength=1; maxLength=500

customer_id

Да

string (uuid)

description

Нет

string / null

start_date

Да

string (date)

end_date

Да

string (date)

pm_id

Да

string (uuid)

admin_id

Нет

string (uuid) / null

eol_id

Да

string (uuid)

classification

Нет

string: open, closed

default="open"

document_set_id

Да

string (uuid)

Если не получается

Что видно

Причина и что сделать

403 «API-ключи не поддерживаются на этом эндпоинте»

У маршрута в таблице указано «Только сессия». Выполните его с заголовком Authorization: Bearer от имени сотрудника, см. вход под пользователем.

422 в мастере

В project не хватает обязательного поля. В отличие от POST /projects, мастер требует еще eol_id.

Этап не готов, хотя файлы загружены

Готовность считается по задаче-вехе документа (related_task_id): она должна быть сдана и принята, то есть в статусе completed. См. приемку в Задачах.

403 «Недостаточно прав (...)»

У пользователя или у сотрудника, выпустившего ключ, нет названного права в роли (с 0.110.6 для ключа проверяются и скоуп, и право владельца). Добавьте право в роль: «Администрирование» → «Доступ» → «Роли и права».

423 на POST, PUT, PATCH или DELETE, чтение работает

Нет действующей лицензии (в ответе license_status: expired, invalid, missing или mismatch). Изменения заблокированы до загрузки файла лицензии, см. Лицензия.

Контроль проекта

Этапы проектов

Конструктор документов

Качество, риски, проблемы и измененияЖизненный цикл и требованияТипы, наборы и требования этапов

Интеграции и REST API

Функциональная карта