Главная / Документация / APIAPI: проекты, программы и портфелиМаршруты проектов, команды, рисков, этапов, базовых планов, программ и портфелей volrix.pm: права, параметры, тела запросов и примеры.Обновлено 27.09.2026Группа описывает верхний уровень управления: карточку проекта с командой, рисками и проблемами, этапы жизненного цикла, базовые планы, показатели здоровья и S-кривую, а также программы и портфели, которые объединяют проекты. Задачи плана вынесены в статью Задачи, план и совместная работа, деньги - в Бюджет и расчеты.**Что принимает API-ключ.** Программы и портфели работают с ключом целиком (скоупы programs:... и portfolios:...). У проектов с ключом доступны только создание (projects:create) и смена текущего этапа (projects:update); чтение списка и карточки, команда, риски и проблемы проверяют участие в проекте и работают только в сессии пользователя.Базовый адрес, формат ответов и коды ошибок описаны в статье API: адрес, первый запрос и ответы, выпуск ключа и вход под пользователем - в статье API: вход, токен и API-ключи. В примерах ключ лежит в переменной окружения VOLRIX_API_KEY, токен пользователя - в VOLRIX_TOKEN.Типовой сценарий: создать проект из внешней системы

Соберите справочники Набор документов - GET /api/v1/document-sets, заказчик - GET /api/v1/organizations?role=customer, руководитель - GET /api/v1/people. Нужны их id.

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

Наберите команду POST /api/v1/projects/{project_id}/team с телом TeamMemberAdd: employee_id обязателен, роль в проекте, ставка, процент загрузки и период - по необходимости.

Переведите статус POST /api/v1/projects/{project_id}/status?new_status=planning. Допустимые статусы - в таблице перечислений ProjectStatus.

Смените этап PATCH /api/v1/projects/{project_id}/current-stage с телом {"stage_id": "..."} (projects:update). Справочник этапов - GET /api/v1/project-stages.

Примеры запросовПроекты в работе, от имени пользователя (сессия). По умолчанию список скрывает черновики: чтобы получить только их, передайте only_drafts=true, чтобы все статусы вместе с черновиками - include_drafts=true.curl --fail-with-body -sS \ -H "Authorization: Bearer $VOLRIX_TOKEN" \ "https://ваш-адрес/api/v1/projects?status=execution&page_size=50"Программы портфеля по ключу (скоуп programs:read). Ответ - массив ProgramListItem без постраничной обертки:curl --fail-with-body -sS \ -H "X-Api-Key: $VOLRIX_API_KEY" \ "https://ваш-адрес/api/v1/programs?portfolio_id=7b1e..."МаршрутыКак читать колонку «Доступ»: **скоуп вида users:read** - маршрут принимает API-ключ, если в ключе есть этот скоуп, а у сотрудника, выпустившего ключ, есть такое же право в роли (users.read). Если скоупов несколько через «+», нужны все. **Только сессия** - нужен заголовок Authorization: Bearer, API-ключ получит 403. **Без авторизации** - заголовки не нужны. Доступ к конкретному объекту (участие в проекте, права на папку Диска) сервер проверяет дополнительно. Пути в таблицах указаны полностью, от корня сервера.Проекты, команда, риски и проблемы

Метод и путь

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

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

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

GET /api/v1/projects

page [query]: integer (default=1, min=1); page_size [query]: integer (default=20, min=1, max=100); search [query]: string / null; status [query]: ProjectStatus / null; customer_id [query]: string (uuid) / null; pm_id [query]: string (uuid) / null; only_drafts [query]: boolean (default=false); include_drafts [query]: boolean (default=false)

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

200: object

POST /api/v1/projects

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

projects:create

201: object

GET /api/v1/projects/{project_id}

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

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

200: object

PUT /api/v1/projects/{project_id}

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

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

200: object

POST /api/v1/projects/{project_id}/status

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

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

200: object

POST /api/v1/projects/{project_id}/submit-plan

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

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

200: object

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

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

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

200: object

POST /api/v1/projects/{project_id}/team

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

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

200: object

PUT /api/v1/projects/{project_id}/team/{member_id}

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

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

200: object

DELETE /api/v1/projects/{project_id}/team/{member_id}

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

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

200: object

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

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

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

200: object

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

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

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

200: object

POST /api/v1/projects/{project_id}/risks

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

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

201: object

PUT /api/v1/projects/{project_id}/risks/{risk_id}

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

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

200: object

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

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

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

200: object

POST /api/v1/projects/{project_id}/issues

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

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

201: object

PUT /api/v1/projects/{project_id}/issues/{issue_id}

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

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

200: object

Программы

Метод и путь

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

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

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

GET /api/v1/programs

portfolio_id [query]: string (uuid) / null

programs:read

200: array[ProgramListItem]

POST /api/v1/programs

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

programs:create

201: ProgramOut

GET /api/v1/programs/{program_id}

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

programs:read

200: ProgramOut

PUT /api/v1/programs/{program_id}

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

programs:update

200: ProgramOut

DELETE /api/v1/programs/{program_id}

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

programs:delete

204

GET /api/v1/programs/{program_id}/dashboard

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

programs:read

200: object

GET /api/v1/programs/{program_id}/risks

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

programs:read

200: ComponentRisks

GET /api/v1/programs/{program_id}/benefits

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

programs:read

200: array[BenefitOut]

POST /api/v1/programs/{program_id}/benefits

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

programs:update

201: BenefitOut

PUT /api/v1/programs/{program_id}/benefits/{benefit_id}

program_id [path обяз.]: string (uuid); benefit_id [path обяз.]: string (uuid) | Тело: application/json: BenefitUpdate

programs:update

200: BenefitOut

DELETE /api/v1/programs/{program_id}/benefits/{benefit_id}

program_id [path обяз.]: string (uuid); benefit_id [path обяз.]: string (uuid)

programs:update

204

GET /api/v1/programs/{program_id}/dependencies

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

programs:read

200: array[DependencyOut]

POST /api/v1/programs/{program_id}/dependencies

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

programs:update

201: DependencyOut

DELETE /api/v1/programs/{program_id}/dependencies/{dependency_id}

program_id [path обяз.]: string (uuid); dependency_id [path обяз.]: string (uuid)

programs:update

204

GET /api/v1/programs/{program_id}/milestones

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

programs:read

200: array[MilestoneOut]

POST /api/v1/programs/{program_id}/milestones

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

programs:update

201: MilestoneOut

PUT /api/v1/programs/{program_id}/milestones/{milestone_id}

program_id [path обяз.]: string (uuid); milestone_id [path обяз.]: string (uuid) | Тело: application/json: MilestoneIn

programs:update

200: MilestoneOut

DELETE /api/v1/programs/{program_id}/milestones/{milestone_id}

program_id [path обяз.]: string (uuid); milestone_id [path обяз.]: string (uuid)

programs:update

204

GET /api/v1/programs/{program_id}/gates

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

programs:read

200: array[GateOut]

POST /api/v1/programs/{program_id}/gates

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

programs:update

201: GateOut

PUT /api/v1/programs/{program_id}/gates/{gate_id}

program_id [path обяз.]: string (uuid); gate_id [path обяз.]: string (uuid) | Тело: application/json: GateIn

programs:update

200: GateOut

DELETE /api/v1/programs/{program_id}/gates/{gate_id}

program_id [path обяз.]: string (uuid); gate_id [path обяз.]: string (uuid)

programs:update

204

Портфели

Метод и путь

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

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

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

GET /api/v1/portfolios

Нет

portfolios:read

200: array[PortfolioListItem]

POST /api/v1/portfolios

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

portfolios:create

201: PortfolioOut

GET /api/v1/portfolios/{portfolio_id}

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

portfolios:read

200: PortfolioOut

PUT /api/v1/portfolios/{portfolio_id}

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

portfolios:update

200: PortfolioOut

DELETE /api/v1/portfolios/{portfolio_id}

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

portfolios:delete

204

GET /api/v1/portfolios/{portfolio_id}/dashboard

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

portfolios:read

200: object

GET /api/v1/portfolios/{portfolio_id}/objectives

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

portfolios:read

200: array[ObjectiveOut]

POST /api/v1/portfolios/{portfolio_id}/objectives

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

portfolios:update

201: ObjectiveOut

PUT /api/v1/portfolios/{portfolio_id}/objectives/{objective_id}

portfolio_id [path обяз.]: string (uuid); objective_id [path обяз.]: string (uuid) | Тело: application/json: ObjectiveUpdate

portfolios:update

200: ObjectiveOut

DELETE /api/v1/portfolios/{portfolio_id}/objectives/{objective_id}

portfolio_id [path обяз.]: string (uuid); objective_id [path обяз.]: string (uuid)

portfolios:update

204

GET /api/v1/portfolios/{portfolio_id}/criteria

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

portfolios:read

200: array[CriterionOut]

POST /api/v1/portfolios/{portfolio_id}/criteria

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

portfolios:update

201: CriterionOut

PUT /api/v1/portfolios/{portfolio_id}/criteria/{criterion_id}

portfolio_id [path обяз.]: string (uuid); criterion_id [path обяз.]: string (uuid) | Тело: application/json: CriterionIn

portfolios:update

200: CriterionOut

DELETE /api/v1/portfolios/{portfolio_id}/criteria/{criterion_id}

portfolio_id [path обяз.]: string (uuid); criterion_id [path обяз.]: string (uuid)

portfolios:update

204

PUT /api/v1/portfolios/{portfolio_id}/scores

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

portfolios:update

204

GET /api/v1/portfolios/{portfolio_id}/ranking

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

portfolios:read

200: PortfolioRanking

GET /api/v1/portfolios/{portfolio_id}/capacity

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

portfolios:read

200: PortfolioCapacity

GET /api/v1/portfolios/{portfolio_id}/risks

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

portfolios:read

200: ComponentRisks

Базовые планы

Метод и путь

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

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

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

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

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

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

200: object

POST /api/v1/projects/{project_id}/baselines

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

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

201: object

GET /api/v1/projects/{project_id}/baselines/current

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

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

200: object

GET /api/v1/projects/{project_id}/baselines/{baseline_id}

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

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

200: object

Здоровье проектов

Метод и путь

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

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

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

GET /api/v1/project-health/summary

Нет

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

200: object

GET /api/v1/project-health/{project_id}

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

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

200: object

Этапы и наборы документов

Метод и путь

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

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

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

GET /api/v1/project-stages

set_id [query]: string (uuid) / null

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

200: array[ProjectStageRead]

GET /api/v1/document-sets

Нет

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

200: object

GET /api/v1/document-sets/{set_id}/documents

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

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

200: object

POST /api/v1/admin/project-stages

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

project_stages:manage

201: ProjectStageRead

PUT /api/v1/admin/project-stages/{stage_id}

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

project_stages:manage

200: ProjectStageRead

DELETE /api/v1/admin/project-stages/{stage_id}

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

project_stages:manage

204

PATCH /api/v1/projects/{project_id}/current-stage

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

projects:update

200: ProjectStageRead / null

S-кривая

Метод и путь

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

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

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

GET /api/v1/projects/{project_id}/s-curve

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

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

200: array[SCurvePoint]

Журнал изменений плана

Метод и путь

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

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

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

GET /api/v1/projects/{project_id}/plan-changes

project_id [path обяз.]: string (uuid); limit [query]: integer (default=50, min=1, max=200)

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

200: object

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

Поле

Обязательно

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

Ограничения

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) / null

classification

Нет

ProjectClassification

default="open"

status

Нет

ProjectStatus

default="initiated"

document_set_id

Да

string (uuid)

program_id

Нет

string (uuid) / null

portfolio_id

Нет

string (uuid) / null

ProjectUpdate: PUT /projects/{project_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

customer_id

Нет

string (uuid) / null

description

Нет

string / null

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

pm_id

Нет

string (uuid) / null

admin_id

Нет

string (uuid) / null

eol_id

Нет

string (uuid) / null

classification

Нет

ProjectClassification / null

document_set_id

Нет

string (uuid) / null

program_id

Нет

string (uuid) / null

portfolio_id

Нет

string (uuid) / null

TeamMemberAdd: POST /projects/{project_id}/team

Поле

Обязательно

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

Ограничения

employee_id

Да

string (uuid)

role_code

Нет

string / null

rate_card_id

Нет

string (uuid) / null

allocation_percent

Нет

number / string / null

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

TeamMemberUpdate: PUT /projects/{project_id}/team/{member_id}

Поле

Обязательно

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

Ограничения

role_code

Нет

string / null

rate_card_id

Нет

string (uuid) / null

allocation_percent

Нет

number / string / null

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

RiskCreate: POST /projects/{project_id}/risks

Поле

Обязательно

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

Ограничения

name

Да

string

description

Нет

string / null

probability

Да

RiskProbability

impact

Да

RiskImpact

response_measures

Нет

string / null

responsible_id

Да

string (uuid)

status

Нет

RiskStatus

default="open"

RiskUpdate: PUT /projects/{project_id}/risks/{risk_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

description

Нет

string / null

probability

Нет

RiskProbability / null

impact

Нет

RiskImpact / null

response_measures

Нет

string / null

responsible_id

Нет

string (uuid) / null

status

Нет

RiskStatus / null

IssueCreate: POST /projects/{project_id}/issues

Поле

Обязательно

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

Ограничения

name

Да

string

description

Нет

string / null

project_impact

Нет

string / null

resolution_measures

Нет

string / null

responsible_id

Да

string (uuid)

status

Нет

IssueStatus

default="open"

IssueUpdate: PUT /projects/{project_id}/issues/{issue_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

description

Нет

string / null

project_impact

Нет

string / null

resolution_measures

Нет

string / null

responsible_id

Нет

string (uuid) / null

status

Нет

IssueStatus / null

ProgramCreate: POST /programs

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=300

code

Нет

string / null

description

Нет

string / null

portfolio_id

Нет

string (uuid) / null

manager_id

Нет

string (uuid) / null

blueprint

Нет

string / null

budget_amount

Нет

number / null

reserve_amount

Нет

number / null

currency

Нет

string

default="RUB"

status

Нет

string: draft, active, on_hold, closed

default="draft"

pipeline_stage

Нет

string: idea, candidate, approved, in_delivery, closed

default="idea"

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

ProgramUpdate: PUT /programs/{program_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

code

Нет

string / null

description

Нет

string / null

portfolio_id

Нет

string (uuid) / null

manager_id

Нет

string (uuid) / null

blueprint

Нет

string / null

budget_amount

Нет

number / null

reserve_amount

Нет

number / null

currency

Нет

string / null

status

Нет

string: draft, active, on_hold, closed / null

pipeline_stage

Нет

string: idea, candidate, approved, in_delivery, closed / null

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

BenefitCreate: POST /programs/{program_id}/benefits

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=300

description

Нет

string / null

metric

Нет

string / null

unit

Нет

string / null

baseline_value

Нет

number / null

target_value

Нет

number / null

actual_value

Нет

number / null

owner_id

Нет

string (uuid) / null

status

Нет

string: planned, in_progress, realized, at_risk, not_realized

default="planned"

due_date

Нет

string (date) / null

BenefitUpdate: PUT /programs/{program_id}/benefits/{benefit_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

description

Нет

string / null

metric

Нет

string / null

unit

Нет

string / null

baseline_value

Нет

number / null

target_value

Нет

number / null

actual_value

Нет

number / null

owner_id

Нет

string (uuid) / null

status

Нет

string: planned, in_progress, realized, at_risk, not_realized / null

due_date

Нет

string (date) / null

DependencyIn: POST /programs/{program_id}/dependencies

Поле

Обязательно

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

Ограничения

predecessor_project_id

Да

string (uuid)

successor_project_id

Да

string (uuid)

dep_type

Нет

string: fs, ss, ff, sf

default="fs"

description

Нет

string / null

MilestoneIn: POST /programs/{program_id}/milestones, PUT /programs/{program_id}/milestones/{milestone_id}

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=300

due_date

Нет

string (date) / null

done

Нет

boolean

default=false

GateIn: POST /programs/{program_id}/gates, PUT /programs/{program_id}/gates/{gate_id}

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=300

kind

Нет

string: gate, tranche

default="gate"

planned_date

Нет

string (date) / null

status

Нет

string: planned, passed, hold, failed

default="planned"

amount

Нет

number / null

decision

Нет

string / null

PortfolioCreate: POST /portfolios

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=300

code

Нет

string / null

description

Нет

string / null

owner_id

Нет

string (uuid) / null

strategic_objective

Нет

string / null

theme

Нет

string / null

budget_amount

Нет

number / null

reserve_amount

Нет

number / null

currency

Нет

string

default="RUB"

status

Нет

string: draft, active, on_hold, closed

default="draft"

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

PortfolioUpdate: PUT /portfolios/{portfolio_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

code

Нет

string / null

description

Нет

string / null

owner_id

Нет

string (uuid) / null

strategic_objective

Нет

string / null

theme

Нет

string / null

budget_amount

Нет

number / null

reserve_amount

Нет

number / null

currency

Нет

string / null

status

Нет

string: draft, active, on_hold, closed / null

start_date

Нет

string (date) / null

end_date

Нет

string (date) / null

ObjectiveCreate: POST /portfolios/{portfolio_id}/objectives

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=300

description

Нет

string / null

metric

Нет

string / null

unit

Нет

string / null

baseline_value

Нет

number / null

target_value

Нет

number / null

actual_value

Нет

number / null

owner_id

Нет

string (uuid) / null

status

Нет

string: planned, in_progress, realized, at_risk, not_realized

default="planned"

due_date

Нет

string (date) / null

ObjectiveUpdate: PUT /portfolios/{portfolio_id}/objectives/{objective_id}

Поле

Обязательно

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

Ограничения

name

Нет

string / null

description

Нет

string / null

metric

Нет

string / null

unit

Нет

string / null

baseline_value

Нет

number / null

target_value

Нет

number / null

actual_value

Нет

number / null

owner_id

Нет

string (uuid) / null

status

Нет

string: planned, in_progress, realized, at_risk, not_realized / null

due_date

Нет

string (date) / null

CriterionIn: POST /portfolios/{portfolio_id}/criteria, PUT /portfolios/{portfolio_id}/criteria/{criterion_id}

Поле

Обязательно

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

Ограничения

name

Да

string

minLength=1; maxLength=200

description

Нет

string / null

weight

Нет

number

default=1; minimum=0.0

ScoreIn: PUT /portfolios/{portfolio_id}/scores

Поле

Обязательно

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

Ограничения

criterion_id

Да

string (uuid)

project_id

Да

string (uuid)

value

Да

integer

minimum=0.0; maximum=5.0

BaselineCreate: POST /projects/{project_id}/baselines

Поле

Обязательно

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

Ограничения

note

Нет

string / null

change_request_id

Нет

string (uuid) / null

ProjectStageCreate: POST /admin/project-stages

Поле

Обязательно

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

Ограничения

code

Да

string

minLength=1; maxLength=50

name

Да

string

minLength=1; maxLength=200

color

Нет

string

default="#228be6"; minLength=4; maxLength=7

sort_order

Нет

integer

default=0

is_active

Нет

boolean

default=true

ProjectStageUpdate: PUT /admin/project-stages/{stage_id}

Поле

Обязательно

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

Ограничения

code

Нет

string / null

name

Нет

string / null

color

Нет

string / null

sort_order

Нет

integer / null

is_active

Нет

boolean / null

Значения перечислений

Тип

Допустимые значения

IssueStatus

open, in_progress, closed

ProjectClassification

open, closed

ProjectStatus

draft, pending, initiated, planning, execution, completed, archived

RiskImpact

low, medium, high

RiskProbability

low, medium, high

RiskStatus

open, in_progress, closed, realized

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

Что видно

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

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

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

GET /projects не находит созданный проект

Проект в статусе draft: общий список скрывает черновики. Передайте include_drafts=true или only_drafts=true.

403 на карточке проекта при верном токене

Проект закрытый (classification: closed), пользователь не входит в команду и у него нет права projects.read_all. Добавьте его в команду или выдайте право.

422 при создании проекта

Не хватает обязательного поля ProjectCreate или «Окончание проекта не может быть раньше начала». Смотрите detail.

403 «API-ключ не имеет права (...)»

В ключе нет скоупа из колонки «Доступ». Скоупы после создания не меняются: выпустите новый ключ с нужным скоупом в «Администрирование» → «Настройки продукта» → «Интеграции» и отзовите старый.

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

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

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

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

Проекты

Программы

Портфели

Создание, команда и ежедневная работаКоординация связанных проектовИнициативы и приоритеты

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

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