Holarch

SysML v2

API и MCP в проектах SysML v2

Чтение, поиск и проверка моделей SysML v2 из скриптов и инструментов ИИ с персональным токеном доступа, предложение изменений, которые вы просматриваете и применяете в Holarch, а также чтение и фиксация через Systems Modeling API, где ветки являются запросами на изменение.

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
  3. Как использовать
    1. Чтение проекта SysML v2 с помощью curl
    2. Проверка текста SysML перед предложением
    3. Предложение изменения и его применение
    4. Подключение инструмента ИИ к проекту SysML v2
    5. Разобранный пример: демо-проект Hybrid Car
    6. Советы
  4. Маршруты REST для проектов SysML v2
    1. Значения
  5. Инструменты MCP для проектов SysML v2
    1. Правки элементов
    2. Предлагаемый текст
  6. Предложения в проектах SysML v2
    1. Рецензирование предложения SysML v2
  7. Systems Modeling API
    1. Коммит изменений
  8. Сообщения
  9. Ограничения
  10. Связанные страницы

Обзор

Проекты SysML v2 работают с теми же REST API, конечной точкой MCP и персональными токенами доступа, что и проекты LML. Скрипты и инструменты ИИ читают модель как элементы и текст SysML, проверяют текст, прежде чем что-либо менять, и предлагают изменения. В модели ничего не меняется, пока человек не просмотрит предложение в Holarch и не применит его.

Три способа доступа:

  • REST API: https://app.holarch.app/api/v1/projects/<project>/… для скриптов и панелей мониторинга. Он читает элементы, требования, диагностику и текст SysML и добавляет изменения в предложение.
  • MCP: https://app.holarch.app/mcp для инструментов ИИ, таких как Claude. Инструменты SysML v2 читают, ищут и проверяют модель и предлагают изменения.
  • Systems Modeling API: https://app.holarch.app/api/v1/sysml/… в формах OMG Systems Modeling API для других инструментов SysML v2. Ветвь main — это действующая модель, она доступна только для чтения; каждая другая ветвь — запрос на изменение, и коммиты делаются в неё. Действующая модель меняется только тогда, когда утверждающий применяет запрос на изменение в Holarch.

Токены, области доступа, списки проектов, переключатель организации, ограничения частоты и подключение Claude такие же, как для проектов LML. О создании токена и подключении инструмента ИИ см. API и MCP. Вызовы Карты программы (GET /api/v1/program-map, GET /api/v1/projects/<project>/items/<item>/trace и инструменты MCP program_map и trace_chain) включают проекты SysML v2 и их элементы.

Понятия

  • Элемент: одна единица модели SysML v2, например определение части, порт или требование. У каждого элемента есть id (UUID). Везде, где маршрут или инструмент запрашивает ID, работает и полное имя, например Vehicles::Car::powertrain.
  • Краткая форма (brief): короткое представление элемента в списках: id, type (метакласс, например PartUsage), name, shortName, qualifiedName и owner.
  • Пакет верхнего уровня: пакет, который не находится внутри другого элемента. Текст SysML проекта — это по одному тексту на каждый пакет верхнего уровня плюс один текст для элементов вне пакетов.
  • Диагностика: проблема, которую находит ядро языка, с полями code, severity (error или warning), elementId, element и args. Синтаксическая диагностика вместо элемента указывает line и col.
  • Предложение: изменения, которые клиент API или инструмент ИИ собирает для рецензирования. На каждую пару токена и проекта открыто одно предложение. Клиент отправляет его на рецензирование с заголовком и сводкой.
  • Постраничные ответы: списки приходят страницами (limit, offset). Длинный текст SysML приходит страницами строк (line, lines). Ответ, в котором что-то пропущено, содержит truncated: true.

Как использовать

Используйте API, когда модель нужна скрипту или инструменту ИИ: чтобы составить отчёт о требованиях без удовлетворяющих или верифицирующих элементов, проверить текст SysML команды по модели или позволить инструменту ИИ подготовить черновик изменений модели, которые затем рецензирует инженер.

Чтение проекта SysML v2 с помощью curl

  1. Создайте токен в разделе Настройки учётной записи → Токены API (см. API и MCP).
  2. Выведите список своих проектов:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/projects

У проектов SysML v2 указано "language": "sysml2".

  1. Получите сводку модели:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/projects/<project>/model

Вы увидите число элементов по метаклассам, пакеты верхнего уровня и количество ошибок и предупреждений.

  1. Найдите элементы, например все определения частей:
curl -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/projects/<project>/elements?type=part%20def&limit=100"
  1. Прочитайте текст SysML пакета:
curl -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/projects/<project>/sysml?root=Vehicles"

Длинный текст заканчивается на "truncated": true и "next": строка, которую нужно запросить следующей через line.

Проверка текста SysML перед предложением

  1. Отправьте новый текст пакета на маршрут проверки:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
  -d '{"root": "Vehicles", "text": "package Vehicles { … }"}' \
  https://app.holarch.app/api/v1/projects/<project>/sysml/check
  1. Прочитайте ответ. ok равно true, когда в тексте нет синтаксических ошибок. diagnostics перечисляет синтаксические ошибки с line и col, а также ошибки, которые текст добавил бы в модель. changes — число изменений модели, которые вносит текст.

Проверка ничего не меняет. Ей нужен только токен чтения.

Предложение изменения и его применение

Токен записи добавляет изменения в открытое предложение токена. Затем клиент отправляет предложение на рецензирование.

  1. Добавьте изменение. Отправьте либо полный новый текст пакета, либо правки элементов:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
  -d '{"edits": [{"op": "create", "kind": "attribute", "owner": "Vehicles::Car", "name": "range", "typedBy": ["LengthValue"]}]}' \
  https://app.holarch.app/api/v1/projects/<project>/proposal/changes

Вы получите 201 с предложением, сводкой изменения и элементами, которые оно добавляет, изменяет и удаляет. Изменение, добавляющее диагностику уровня ошибки, отклоняется (см. Предложения в проектах SysML v2).

  1. Таким же образом добавьте другие изменения. Каждое изменение проверяется по модели с применёнными ранее изменениями предложения.
  2. Отправьте предложение на рецензирование:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
  -d '{"title": "Add range attribute", "summary": "Adds Car::range for the range requirement."}' \
  https://app.holarch.app/api/v1/projects/<project>/proposal
  1. В Holarch откройте проект, затем откройте ✦ ИИ ▾ → Рецензировать «Add range attribute»… (или уведомление под значком колокольчика).
  2. Проверьте строки и нажмите Применить выбранные.

    Отмеченные изменения применяются с вашим именем в истории, и одно нажатие “Отменить” возвращает всё назад.

Подключение инструмента ИИ к проекту SysML v2

  1. Подключите инструмент ИИ к https://app.holarch.app/mcp с токеном или через вход (см. API и MCP).
  2. Спросите о модели, например “Кратко опиши модель Hybrid Car в Holarch” или “Какие требования в проекте Hybrid Car не верифицированы?”.

    Инструмент ИИ использует model_summary, list_elements, list_requirements и другие инструменты чтения.

  3. Попросите изменение, например “Предложи атрибут range для Car”.

    Инструмент ИИ читает пакет с помощью get_sysml, предлагает текст или правки элементов и исправляет диагностику, которую возвращает проверка.

  4. Просмотрите предложение в Holarch и нажмите Применить выбранные.

Разобранный пример: демо-проект Hybrid Car

Создайте демо-проект через Управление проектами → Файлы проектов ▾ → Новый демо-проект → Hybrid Car (SysML v2), затем создайте для него токен чтения и записи.

  1. GET /api/v1/projects/<project>/model перечисляет пакеты верхнего уровня, среди них Vehicles, HybridCarArchitecture и VehicleBehavior.
  2. GET /api/v1/projects/<project>/elements?query=Engine&type=part%20def находит Vehicles::Engine.
  3. GET /api/v1/projects/<project>/elements/Vehicles::Engine возвращает определение части с его текстом SysML, членами (displacement, cylinders, maxPower, порты fuelIn, output и ecu) и использованиями, типизированными им.
  4. GET /api/v1/projects/<project>/elements/Vehicles::Car/connections перечисляет интерфейс driveShaft от powertrain.output к frontAxle.input.
  5. GET /api/v1/projects/<project>/requirements?status=unverified перечисляет требования, которые не верифицирует ни один случай верификации, с их ID, например VR-4.1.
  6. POST /api/v1/projects/<project>/proposal/changes с {"edits": [{"op": "update", "id": "Vehicles::Engine", "doc": "Gasoline engine of the hybrid powertrain."}]} добавляет изменение в предложение. POST /api/v1/projects/<project>/proposal с заголовком отправляет его.
  7. В Holarch ✦ ИИ ▾ → Рецензировать «…» показывает Изменено: с определением части и полем doc, а также разницу текста Vehicles. Применить выбранные применяет изменение.

Советы

  • Прочитайте пакет с помощью get_sysml (или GET …/sysml?root=), прежде чем предлагать для него новый текст. Элементы, не вошедшие в предлагаемый текст, удаляются.
  • Для небольших изменений предпочитайте правки элементов. Они меняют только названные элементы и оставляют остальной текст пакета как есть.
  • Сначала проверьте текст с помощью check_sysml (или POST …/sysml/check). Он возвращает ту же диагностику, с которой было бы отклонено предложение.
  • В скриптах называйте элементы по полному имени. ID при переименовании элемента не меняются, а полные имена меняются.
  • Давайте инструменту ИИ токен только для чтения, если он лишь отвечает на вопросы о модели.

Маршруты REST для проектов SysML v2

Базовый адрес: https://app.holarch.app/api/v1. Ответы — в JSON. /api/v1/openapi.json (OpenAPI 3.1) описывает эти маршруты вместе с остальными.

Метод и путьЧто он делает
GET /projects/<project>/modelЧисло элементов по метаклассам, пакеты верхнего уровня с числом их элементов и количество ошибок и предупреждений
GET /projects/<project>/elementsПоиск: query (или q; текст в имени, кратком имени, полном имени или doc), type, owner, limit (1–500, по умолчанию 50), offset; сортировка по полному имени
GET /projects/<project>/elements/<id>Один элемент с его полями, doc, текстом SysML, членами и использованиями, типизированными им; members (0–200, по умолчанию 100)
GET /projects/<project>/elements/<id>/connectionsСоединения, интерфейсы, связывания, потоки (с предметом), последовательности, переходы, распределения и зависимости у элемента или его характеристик, а также принадлежащие ему внутри; limit (по умолчанию 100)
GET /projects/<project>/requirementsТребования с их ID, формулировкой (doc), satisfiedBy и verifiedBy; owner, status (unsatisfied или unverified), limit (по умолчанию 100), offset
GET /projects/<project>/diagnosticsДиагностика модели, сначала ошибки; ids (через запятую: только эти элементы и их члены), limit (по умолчанию 200, не более 500)
GET /projects/<project>/sysmlТекст SysML пакета верхнего уровня (root), элементов вне пакетов (без root) или одного элемента (element); line (первая строка, начиная с 1), lines (по умолчанию 2000, не более 5000)
POST /projects/<project>/sysml/checkПроверить text как новый текст root (или элементов вне пакетов); ничего не меняет
POST /projects/<project>/proposal/changesДобавить изменение в открытое предложение: {text, root} или {edits}
GET /projects/<project>/proposalОткрытое предложение или предложение по ID proposal с его статусом и изменениями
POST /projects/<project>/proposalОтправить открытое предложение на рецензирование: title, summary
DELETE /projects/<project>/proposalОтбросить открытое предложение до его отправки

GET /projects и GET /projects/<project> тоже работают для проектов SysML v2. Они возвращают "language": "sysml2", а ответ по проекту дополнительно содержит elements и types (число элементов по метаклассам).

Маршруты сущностей LML (/entities, /relationships, /schema, проверки модели и проверка качества) в проекте SysML v2 отвечают 409 wrong-project-type. Маршруты SysML v2 отвечают так же в проекте LML.

Значения

  • type: метакласс, например PartUsage или RequirementDefinition, или ключевое слово в том виде, в каком оно пишется в тексте SysML: part, part def, attribute, port, requirement, action, package и другие ключевые слова элементов.
  • owner, id, element, root: ID или полное имя. root также принимает имя пакета верхнего уровня. root должен быть пакетом верхнего уровня; чтобы прочитать текст одного элемента, используйте element.
  • Длинные значения: doc в списке обрезается до 4000 символов, doc отдельного элемента — до 20 000, а собственный текст SysML элемента — до 16 000 символов.

Инструменты MCP для проектов SysML v2

Конечная точка MCP перечисляет эти инструменты рядом с инструментами LML. Инструмент ИИ находит проекты SysML v2 с помощью list_projects (language: sysml2). Каждый инструмент принимает project.

Инструменты чтения также принимают необязательный параметр change_request (CR-12 или его ID), чтобы читать модель такой, какой её сделал бы этот запрос на изменение; propose_sysml и propose_element_changes принимают его, чтобы вычислить изменение относительно модели запроса и после рецензирования применить его в этот черновик. Правила см. в разделе Запросы на изменение.

ИнструментДоступЧто он делает
model_summaryЧтениеЧисло элементов по метаклассам, пакеты верхнего уровня и количество диагностик
list_elementsЧтениеПоиск элементов по тексту (query), type и owner; постранично с limit и offset
get_elementЧтениеОдин элемент (id) с его типами, специализациями, кратностью, значением, концами, doc, текстом SysML, членами (members, не более 200) и использованиями, типизированными им
get_connectionsЧтениеСоединения, интерфейсы, связывания, потоки, последовательности, переходы, распределения и зависимости элемента (id, limit)
list_requirementsЧтениеТребования с их ID, формулировкой, satisfy и verify; owner, status (unsatisfied, unverified), limit, offset
get_sysmlЧтениеТекст SysML пакета верхнего уровня (root), элементов вне пакетов или одного элемента (element); line, lines (не более 5000); ответ содержит next
get_sysml_textЧтениеТекст SysML всей модели (каждый пакет верхнего уровня, затем элементы вне пакетов) или одного пакета package, до 200 000 символов на ответ; ответ называет пропущенные пакеты
check_sysmlЧтениеБез text: диагностика модели (ids, limit). С text (и root): синтаксические ошибки со строкой и столбцом и ошибки, которые добавил бы текст. Ничего не меняет
propose_sysmlЧтение и записьПредложить полный новый текст text пакета верхнего уровня (root) или элементов вне пакетов (без root; сюда же попадает новый пакет)
propose_element_changesЧтение и записьПредложить правки edits (не более 100) без переписывания текста: создать, обновить, переместить или удалить

list_diagrams, get_diagram и get_matrix работают и в проектах SysML v2: list_diagrams перечисляет представления (с их видом, например InterconnectionView) и диаграммы анализа, хранящиеся под элементом; get_diagram возвращает элементы, которые представление показывает после своих фильтров (по ID элемента или полному имени); get_matrix возвращает каждое требование вместе с тем, что ему удовлетворяет и что его верифицирует.

Инструменты предложений проектов LML работают здесь так же: propose_changes отправляет предложение с заголовком и сводкой, discard_proposal отбрасывает его, а get_proposal и list_proposals показывают его статус. Токен только для чтения видит только инструменты чтения.

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

Правки элементов

Каждая правка в edits (MCP) или {"edits": […]} (REST) — объект с полем op:

opПоля
createkind (ключевое слово, например part, part def, attribute, port, requirement, action, package) или type (метакласс); owner (если не указан — верхний уровень); name (обязательно); необязательные shortName, typedBy, specializes, subsets, redefines, multiplicity, value, doc, direction (in, out, inout)
updateid и изменяемые поля, как для создания; null или "" очищает поле
moveid и новый owner
removeid; удаляет элемент вместе с его членами
  • typedBy, specializes, subsets и redefines — списки до 20 имён: ID, полные имена или имена в том виде, в каком они пишутся в тексте (работают и библиотечные имена, например MassValue).
  • Последующие правки могут называть элементы, созданные ранее в том же вызове, как new:1, new:2 … в порядке создания, например в качестве owner. Ответ перечисляет их в created с новыми ID.
  • Переименование элемента также обновляет ссылки, которые называли его по старому имени.

Предлагаемый текст

  • propose_sysml заменяет весь текст пакета. Элементы сохраняют свои ID, если текст по-прежнему их объявляет. Элементы, не вошедшие в текст, удаляются.
  • Текст должен разбираться так, чтобы ничего не осталось неприменённым. Текст, который не меняет модель, отклоняется (no-change).

Предложения в проектах SysML v2

Каждое предлагаемое изменение проверяется ядром языка, прежде чем войти в предложение:

  • Текст разбирается без синтаксических ошибок, а правки элементов применяются.
  • Изменённые пакеты по-прежнему выводятся как текст SysML и снова разбираются.
  • Изменение не добавляет в модель диагностику уровня ошибки, например неразрешённые имена или ошибки типов. Ошибки, которые уже были в модели, не учитываются.

Изменение, не прошедшее проверку, отклоняется с диагностикой (до 50), которую нужно исправить. Ничего не сохраняется. Предупреждения не приводят к отклонению изменения.

Для предложения нужны токен чтения и записи и роль редактора или владельца в проекте. Одно предложение содержит не более 200 изменений и 8 МБ.

Рецензирование предложения SysML v2

Откройте проект, затем ✦ ИИ ▾ → Рецензировать «<title>»…. Каждое изменение — строка с флажком:

  • Добавлено, Изменено и Удалено перечисляют элементы с изменёнными полями (первые 20 в каждой группе; “и ещё n” для остальных).
  • Разница текста, подписанная именем пакета, показывает текст SysML до и после.
  • Изменение, удаляющее элементы, помечается и изначально не отмечено.
  • Чтобы применить это изменение, откройте модель SysML v2. Модель не загружена; откройте страницу SysML v2 проекта.
  • Пакета больше нет в модели; пропущено. Пакет был удалён после того, как изменение было предложено.

Применить выбранные заново синхронизирует каждое текстовое изменение с текущей моделью и сохраняет правки, элементы которых ещё существуют. Команда проверяет весь набор и применяет его одним шагом отмены. Изменения, которые больше не подходят, пропускаются и называются в уведомлении. Отклонить и Позже работают так же, как для предложений LML, как и роли, срок действия (7 дней) и хранение (см. Предложения от клиентов ИИ).

Systems Modeling API

Другие инструменты SysML v2 читают и изменяют модели Holarch через маршруты в формах OMG Systems Modeling API (REST/HTTP). Базовый адрес — https://app.holarch.app/api/v1/sysml. Используются те же токены; читать может любая роль в проекте, а делать коммиты — редакторы и владельцы.

  • Проекты: перечисляются только проекты SysML v2. @id проекта — UUID, который присваивает этот API; ID проекта Holarch тоже работает. Ответ содержит holarchId и url.
  • Ветви: main — действующая модель, её нельзя изменить через API. Каждая другая ветвь — запрос на изменение в работе с именем вида “CR-12 Заголовок” и полем holarchChangeRequest (id, label, status, url). Запросы на изменение, реализованные или отозванные за последние 30 дней, по-прежнему перечисляются с установленным deleted.
  • Коммиты: коммит записывает изменения в ветвь запроса на изменение. Отдаются только головы ветвей: голова main — действующая модель, голова ветви запроса на изменение — действующая модель с изменениями запроса. Более старые ID коммитов отвечают 404; получайте текущую голову из ветви.
  • Элементы: у каждого элемента есть все свойства его метакласса из JSON-схемы OMG, включая производные (owner, ownedElement, qualifiedName, feature, type и подобные). На элементы стандартной библиотеки ссылаются по их стандартным ID — тем, которые другие инструменты SysML v2 используют для того же библиотечного элемента.
  • Теги и сохранённые запросы: отсутствуют; их списки пусты.
Метод и путьЧто он делает
GET /sysml/projectsВаши проекты SysML v2
POST /sysml/projectsСоздать пустой проект SysML v2 (name, description)
GET /sysml/projects/<projectId>Один проект с его ветвью по умолчанию
GET /sysml/projects/<projectId>/branchesmain и ветви запросов на изменение
POST /sysml/projects/<projectId>/branchesСоздать ветвь: новый запрос на изменение в статусе Draft (name — его заголовок, description — его обоснование)
GET /sysml/projects/<projectId>/branches/<branchId>Ветвь (её @id или main) с head
DELETE /sysml/projects/<projectId>/branches/<branchId>Отозвать запрос на изменение
GET /sysml/projects/<projectId>/commitsГоловы и коммиты, отправленные в ветви, сначала новые
POST /sysml/projects/<projectId>/commits?branchId=<branchId>Коммит изменений в ветвь (ниже)
GET /sysml/projects/<projectId>/commits/<commitId>Головной коммит
GET /sysml/projects/<projectId>/commits/<commitId>/changesЧто ветвь меняет относительно действующей модели: по одному DataVersion на элемент
GET /sysml/projects/<projectId>/commits/<commitId>/elementsВсе элементы коммита, постранично
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId>Один элемент
GET /sysml/projects/<projectId>/commits/<commitId>/rootsЭлементы верхнего уровня, постранично
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId>/relationshipsСвязи, в которых элемент является источником или целью; direction — in, out или both (по умолчанию), постранично
POST /sysml/projects/<projectId>/query-resultsЭлементы, соответствующие запросу (тело ниже), постранично; commitId должен быть головой
GET /sysml/projects/<projectId>/tags, /queries, /commits/<commitId>/elements/<elementId>/projectUsagesПустые списки

Ответы-списки — массивы JSON. Списки разбиваются на страницы с помощью page[size] (по умолчанию 100, не более 1000) и page[after] (@id последнего элемента предыдущей страницы) или page[before] (@id первого элемента следующей страницы). Заголовок Link указывает следующую страницу с rel="next" и предыдущую с rel="prev".

Запрос — объект JSON с необязательными полями where (PrimitiveConstraint с property, operator (=, in, <, <=, >, >= или instanceOf), value и inverse либо CompositeConstraint с operator and или or и constraint), scope (ID элементов: поиск охватывает их и то, чем они владеют) и select (возвращаемые свойства; @id и @type возвращаются всегда):

curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
  "https://app.holarch.app/api/v1/sysml/projects/<projectId>/query-results" \
  -d '{"@type": "Query", "where": {"@type": "PrimitiveConstraint", "property": "@type", "operator": "=", "value": "PartDefinition", "inverse": false}, "select": ["name", "qualifiedName"]}'

Чтение элементов модели:

curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/sysml/projects
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/sysml/projects/<projectId>/branches/main
curl -i -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/sysml/projects/<projectId>/commits/<head id>/elements?page[size]=500"

Коммит изменений

Для записи нужны токен с доступом на чтение и запись, роль редактора или владельца, тариф Team (также для академических учётных записей и учебных групп) и включённое рецензирование ветвей в проекте (Запросы на изменение → Настройки). Утверждающий рецензирует и применяет запрос на изменение в Holarch; токены никогда не голосуют и не применяют.

  1. Создайте ветвь: POST /branches с {"@type": "Branch", "name": "Cabin heater"}. Ответ — ветвь с её holarchChangeRequest.
  2. Прочитайте голову ветви и её элементы.
  3. POST /commits?branchId=<branch @id> со списком DataVersion:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
  "https://app.holarch.app/api/v1/sysml/projects/<projectId>/commits?branchId=<branch id>" \
  -d '{"@type": "Commit", "description": "Add the heater",
       "previousCommit": {"@id": "<head id>"},
       "change": [{"@type": "DataVersion", "identity": {"@id": "<new uuid>"},
                   "payload": {"@type": "PartDefinition", "declaredName": "CabinHeater", "owner": {"@id": "<package id>"}}}]}'
  • Изменение элемента: отправьте элемент в том виде, в каком вы его прочитали, с изменёнными свойствами. Учитываются только собственные свойства (declaredName, ownedRelationship, isAbstract и подобные); производные игнорируются, поэтому отправка обратно прочитанного ничего не меняет. Свойство, которое вы не указали, сохраняет своё значение; чтобы очистить его, отправьте null или [].
  • Новые элементы: присвойте элементу новый UUID и укажите либо его владеющее членство (отправленное в том же коммите), либо owner, который создаст членство за вас.
  • Удаление элемента: payload: null удаляет его вместе со всем, чем он владеет.
  • Проверки: каждый пакет, затронутый коммитом, должен снова выводиться и разбираться, и коммит не должен добавлять диагностику уровня ошибки; иначе ответ — 422 с диагностикой diagnostics, которую нужно исправить.
  • previousCommit: голова, на основе которой было сделано ваше изменение. Если ветвь с тех пор сдвинулась, ответ — 409 stale-head с текущим head; прочитайте снова и сделайте коммит поверх неё.
  • Повторы: отправляйте заголовок Idempotency-Key. Повтор с тем же ключом и телом в течение 24 часов снова получает первый ответ.
  • Коммиты в main: коммит без branchId или с main попадает в собственный черновик запроса на изменение вашего токена (“API changes from <token name>”), созданный при первом таком коммите. Ответ указывает, какой именно, в holarchChangeRequest и в заголовке Warning.
  • Новые проекты: у проекта, созданного через POST /sysml/projects, рецензирование ветвей включено. Его первый коммит в main, пока вы его единственный участник, записывается в модель напрямую, один раз; последующие коммиты проходят через запросы на изменение.

Отправьте запрос на изменение на рецензирование с помощью POST /api/v1/projects/<project>/change-requests/<CR-12>/submit (API и MCP). Теги, слияния, а также переименование или удаление проекта отвечают 405 с указанием, что делать вместо этого. Ошибки содержат @type Error и description, как их определяет OMG API.

Сообщения

Действуют коды из раздела API и MCP. Маршруты и инструменты SysML v2 добавляют:

КодСтатусЗначение
wrong-project-type409Операция LML в проекте SysML v2 или операция SysML v2 в проекте LML
syntax422В предлагаемом тексте есть синтаксические ошибки; диагностика указывает строку и столбец
invalid-model422Изменение добавляет в модель диагностику уровня ошибки; она перечисляется
not-printable422Изменение невозможно записать как текст SysML
invalid422Изменение не удалось применить к модели
no-change400Текст не меняет модель
too-large413Текст длиннее 1 000 000 символов или предложение больше 8 МБ
too-many413 или 409Более 100 правок в одном вызове (413) или предложение уже содержит 200 изменений (409)
stale409Предыдущее текстовое изменение предложения больше не применяется к модели
not-found404Нет такого проекта, элемента, ветви или коммита (Systems Modeling API отдаёт только головы ветвей)
not-writable405Теги, слияния, переименование или удаление проекта через Systems Modeling API; сделайте это в Holarch
main-protected405Удаление main; вместо этого удалите ветвь запроса на изменение
stale-head409Ветвь сдвинулась после previousCommit; прочитайте её head и сделайте коммит снова
branch-base409Новая ветвь должна начинаться с головы main
branch-review-off409В проекте не используется рецензирование ветвей; владелец включает его в разделе «Запросы на изменение → Настройки»
cr-not-draft409Запрос на изменение отправлен или закрыт; записывать в него можно только в статусах Draft или Rejected
cr-full409Запрос на изменение содержит 5000 изменённых элементов или проект — 20 МБ черновиков запросов на изменение
plan-limit403Запись в запросы на изменение требует тарифа Team
orphan422У нового элемента нет владельца; отправьте его владеющее членство или owner
unknown-metaclass422@type полезной нагрузки не является метаклассом SysML v2
idempotency-key-reused422Idempotency-Key уже использовался с другим телом; отправьте новый ключ
token-projects403Токен, ограниченный списком проектов, не может создать проект
bad-request400Отсутствующее или неверное значение, например root, который не является пакетом верхнего уровня, неизвестный op или новый элемент без имени

Ограничения

ЧтоОграничение
Элементов, требований или соединений на страницу500
Членов, перечисляемых с элементом200
Диагностик на ответ500
Строк текста SysML на ответ5000 и не более 400 000 байт (обрезка по строке)
Текст doc4000 символов в списках, 20 000 для одного элемента
Собственный текст SysML элемента16 000 символов
Текст в одном вызове propose_sysml1 000 000 символов
Правок в одном вызове100
Элементов, перечисляемых как добавленные, изменённые или удалённые в одном измененииПо 300
Изменений в одном предложении200 и 8 МБ
Страница Systems Modeling API1000 элементов (по умолчанию 100)
DataVersion в одном коммите5,000
Изменённых элементов в одном запросе на изменение5,000
Тело коммита32 МБ

Ограничения частоты, размер запроса и правила токенов — как в разделе API и MCP.

SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.