Holarch

SysML v2

SysML v2 プロジェクトでの API と MCP

個人用アクセストークンを使ってスクリプトや AI ツールから SysML v2 モデルを読み取り、検索し、チェックします。変更を提案して Holarch でレビューして適用し、Systems Modeling API を通じて読み取りとコミットを行います(ブランチは変更要求になります)。

使い方 →

このページの内容
  1. 概要
  2. 概念
  3. 使い方
    1. curl で SysML v2 プロジェクトを読み取る
    2. 提案する前に SysML テキストをチェックする
    3. 変更を提案して適用する
    4. AI ツールを SysML v2 プロジェクトに接続する
    5. 作業例:Hybrid Car デモ
    6. ヒント
  4. SysML v2 プロジェクトの REST ルート
    1. 値
  5. SysML v2 プロジェクトの MCP ツール
    1. 要素の編集
    2. 提案されたテキスト
  6. SysML v2 プロジェクトの提案
    1. SysML v2 の提案をレビューする
  7. Systems Modeling API
    1. 変更をコミットする
  8. メッセージ
  9. 制限事項
  10. 関連ページ

概要

SysML v2 プロジェクトは、LML プロジェクトと同じ REST API、MCP エンドポイント、個人用アクセストークンで動作します。スクリプトと AI ツールは、モデルを要素と SysML テキストとして読み取り、何かを変更する前にテキストをチェックし、変更を提案します。人が Holarch で提案をレビューして適用するまで、モデルは何も変わりません。

3 つの入口:

  • REST API:スクリプトとダッシュボード用の https://app.holarch.app/api/v1/projects/<project>/…。要素、要求、診断、SysML テキストを読み取り、提案に変更を追加します。
  • MCP:Claude などの AI ツール用の https://app.holarch.app/mcp。SysML v2 ツールはモデルを読み取り、検索、チェックし、変更を提案します。
  • Systems Modeling API:他の SysML v2 ツール用に、OMG Systems Modeling API の形式で提供される https://app.holarch.app/api/v1/sysml/…。ブランチ main はライブモデルで、読み取り専用です。それ以外のすべてのブランチは変更要求で、コミットはそこに入ります。ライブモデルが変わるのは、承認者が Holarch で変更要求を適用したときだけです。

トークン、スコープ、プロジェクトの一覧、組織の切り替え、レート制限、Claude の接続は、LML プロジェクトと同じです。トークンの作成と AI ツールの接続については、API と MCPを参照してください。プログラムマップの呼び出し(GET /api/v1/program-map、GET /api/v1/projects/<project>/items/<item>/trace、および MCP ツール program_map と trace_chain)には、SysML v2 プロジェクトとその要素が含まれます。

概念

  • 要素:パート定義、ポート、要求など、SysML v2 モデルの 1 つの項目。各要素はID(UUID)を持ちます。ルートやツールが ID を求める箇所では、Vehicles::Car::powertrain のような修飾名も使えます。
  • ブリーフ:一覧における要素の短い形式:id、type(PartUsage などのメタクラス)、name、shortName、qualifiedName、owner。
  • 最上位パッケージ:他の要素の中にないパッケージ。プロジェクトの SysML テキストは、最上位パッケージごとに 1 つのテキストと、パッケージ外の要素用の 1 つのテキストからなります。
  • 診断:言語コアが見つけた問題で、code、severity(error または warning)、elementId、element、args を持ちます。構文の診断は、要素の代わりに line と col を示します。
  • 提案:API クライアントや AI ツールがレビューのために集めた変更。トークンとプロジェクトごとに 1 つの提案が開かれます。クライアントは、タイトルと概要を付けてそれをレビューに送ります。
  • ページ単位の応答:一覧はページ単位で返されます(limit、offset)。長い SysML テキストは行のページ単位で返されます(line、lines)。何かを省略した応答には truncated: true が示されます。

使い方

スクリプトや AI ツールがモデルを必要とするときに API を使います。たとえば、満足または検証する要素のない要求を報告する、チームの SysML テキストをモデルと照合する、エンジニアが後でレビューするモデル変更を AI ツールに下書きさせる、といった場合です。

curl で SysML v2 プロジェクトを読み取る

  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 でプロジェクトを開き、✦ AI ▾ → Review “Add range attribute”…(またはベルの下の通知)を開きます。
  2. 行を確認し、選択した項目を適用をクリックします。

    チェックした変更が適用され、履歴にはあなたの名前が記録されます。1 回の元に戻すですべて取り消せます。

AI ツールを SysML v2 プロジェクトに接続する

  1. トークンまたはサインインで、AI ツールを https://app.holarch.app/mcp に接続します(API と MCPを参照)。
  2. モデルについて質問します。たとえば「Holarch の Hybrid Car モデルを要約して」や「Hybrid Car プロジェクトで検証されていない要求はどれ?」。

    AI ツールは model_summary、list_elements、list_requirements などの読み取りツールを使います。

  3. 変更を依頼します。たとえば「Car に range 属性を提案して」。

    AI ツールは 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 は、powertrain.output から frontAxle.input へのインターフェース driveShaft を一覧表示します。
  5. GET /api/v1/projects/<project>/requirements?status=unverified は、どの検証ケースにも検証されていない要求を、VR-4.1 などの ID とともに一覧表示します。
  6. {"edits": [{"op": "update", "id": "Vehicles::Engine", "doc": "Gasoline engine of the hybrid powertrain."}]} を付けた POST /api/v1/projects/<project>/proposal/changes は、変更を提案に追加します。タイトルを付けた POST /api/v1/projects/<project>/proposal がそれを送信します。
  7. Holarch では、✦ AI ▾ → Review “…”に、パート定義とフィールド doc とともにChanged:が表示され、Vehicles のテキスト差分が表示されます。選択した項目を適用でそれが適用されます。

ヒント

  • パッケージに新しいテキストを提案する前に、get_sysml(または GET …/sysml?root=)でそのパッケージを読み取ります。提案したテキストから除外された要素は除去されます。
  • 小さな変更には要素の編集を使うことをお勧めします。指定した要素だけを変更し、パッケージの残りのテキストはそのまま保持します。
  • まず check_sysml(または POST …/sysml/check)でテキストをチェックします。提案が拒否される場合と同じ診断が返されます。
  • スクリプトでは、要素を修飾名で指定します。要素の名前を変更しても ID は変わりませんが、修飾名は変わります。
  • モデルについての質問に答えるだけの AI ツールには、読み取り専用トークンを渡します。

SysML v2 プロジェクトの REST ルート

ベースアドレス: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>1 つの要素とそのフィールド、doc、SysML テキスト、メンバー、それで型付けされた使用。members(0~200、既定 100)
GET /projects/<project>/elements/<id>/connections要素またはそのフィーチャーにある接続、インターフェース、バインディング、フロー(アイテム付き)、サクセッション、遷移、割り当て、依存関係、およびその内部で所有されているもの。limit(既定 100)
GET /projects/<project>/requirementsID、記述(doc)、satisfiedBy、verifiedBy を持つ要求。owner、status(unsatisfied または unverified)、limit(既定 100)、offset
GET /projects/<project>/diagnosticsモデルの診断(エラーが先)。ids(カンマ区切り:それらの要素とそのメンバーのみ)、limit(既定 200、最大 500)
GET /projects/<project>/sysml最上位パッケージ(root)、パッケージ外の要素(root なし)、または 1 つの要素(element)の SysML テキスト。line(最初の行、1 から)、lines(既定 2000、最大 5000)
POST /projects/<project>/sysml/checktext を root(またはパッケージ外の要素)の新しいテキストとしてチェックします。何も変更しません
POST /projects/<project>/proposal/changes開いている提案に変更を追加します:{text, root} または {edits}
GET /projects/<project>/proposal開いている提案、または proposal ID で指定した提案と、そのステータスおよび変更
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 は最上位パッケージである必要があります。1 つの要素のテキストを読み取るには element を使います。
  • 長い値:一覧の doc は 4,000 文字で、単一要素の doc は 20,000 文字で、要素自体の SysML テキストは 16,000 文字で切り詰められます。

SysML v2 プロジェクトの MCP ツール

MCP エンドポイントは、これらのツールを LML のツールと並べて一覧表示します。AI ツールは list_projects(language: sysml2)で SysML v2 プロジェクトを見つけます。すべてのツールは project を受け取ります。

読み取りツールは、省略可能な change_request(CR-12 またはその ID)も受け取り、その変更要求を適用した場合のモデルを読み取ります。propose_sysml と propose_element_changes はこれを受け取ると、要求のモデルに対して変更を計算し、レビュー後にその下書きに適用します。ルールについては変更要求を参照してください。

ツールアクセス機能
model_summary読み取りメタクラスごとの要素数、最上位パッケージ、診断の数
list_elements読み取りテキスト(query)、type、owner で要素を検索。limit と offset でページ分割
get_element読み取り1 つの要素(id)と、その型、特化、多重度、値、端、doc、SysML テキスト、メンバー(members、最大 200)、それで型付けされた使用
get_connections読み取り要素の接続、インターフェース、バインディング、フロー、サクセッション、遷移、割り当て、依存関係(id、limit)
list_requirements読み取りID、記述、satisfy、verify を持つ要求。owner、status(unsatisfied、unverified)、limit、offset
get_sysml読み取り最上位パッケージ(root)、パッケージ外の要素、または 1 つの要素(element)の SysML テキスト。line、lines(最大 5000)。応答には next が含まれます
get_sysml_text読み取りモデル全体(すべての最上位パッケージ、次にパッケージ外の要素)または 1 つの package の SysML テキスト。1 回の応答につき最大 200,000 文字。応答には除外されたパッケージが示されます
check_sysml読み取りtext なし:モデルの診断(ids、limit)。text(と root)あり:行と列付きの構文エラーと、テキストが加えるエラー。何も変更しません
propose_sysml読み取りと書き込み最上位パッケージ(root)、またはパッケージ外の要素(root なし。新しいパッケージを置く場合も同様)の新しい text 全体を提案します
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 はそのステータスを表示します。読み取り専用トークンでは、読み取りツールだけが一覧表示されます。

ツールのエラーは、メッセージと診断を含むツールの結果として返されるため、AI ツールはテキストを修正して再試行できます。

要素の編集

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 と、create と同様に変更するフィールド。null または "" でフィールドをクリアします
moveid と新しい owner
removeid。要素をそのメンバーとともに除去します
  • typedBy、specializes、subsets、redefines は、最大 20 個の名前のリストです:ID、修飾名、またはテキストで書かれる名前(MassValue などのライブラリ名も使えます)。
  • 後の編集では、同じ呼び出しで先に作成した要素を、作成順に new:1、new:2 … として指定できます(たとえば owner として)。応答には、それらが新しい ID とともに created の下に一覧表示されます。
  • 要素の名前を変更すると、古い名前でそれを参照していた参照も更新されます。

提案されたテキスト

  • propose_sysml はパッケージのテキスト全体を置き換えます。テキストがまだ宣言している要素は ID を保持します。テキストから除外された要素は除去されます。
  • テキストは、未適用のものを残さずに解析できる必要があります。モデルを変更しないテキストは拒否されます(no-change)。

SysML v2 プロジェクトの提案

提案されたすべての変更は、提案に加わる前に言語コアによってチェックされます:

  • テキストが構文エラーなしで解析され、要素の編集が適用されること。
  • 変更されたパッケージが引き続き SysML テキストとして出力でき、再び解析できること。
  • 変更が、未解決の名前や型エラーなどのエラーの診断をモデルに加えないこと。モデルにもともとあったエラーは数えません。

失敗した変更は、修正すべき診断(最大 50 件)とともに拒否されます。何も保存されません。警告では変更は拒否されません。

提案には、読み書きトークンと、プロジェクトでの編集者またはオーナーのロールが必要です。1 つの提案には最大 200 件の変更と 8 MB まで含められます。

SysML v2 の提案をレビューする

プロジェクトを開き、✦ AI ▾ → Review “<title>”…を開きます。各変更はチェックボックス付きの行です:

  • Added、Changed、Removedには、要素が変更されたフィールドとともに一覧表示されます(それぞれ最初の 20 件。残りは「and n more」)。
  • パッケージ名のラベルが付いたテキスト差分に、変更前と変更後の SysML テキストが表示されます。
  • 要素を除去する変更にはフラグが付き、チェックが外れた状態で始まります。
  • この変更を適用するには、SysML v2 モデルを開いてください。モデルが読み込まれていません。プロジェクトの SysML v2 ページを開きます。
  • パッケージがモデルにないため、スキップしました。変更が提案された後にパッケージが除去されました。

選択した項目を適用は、各テキスト変更を現在のモデルに対して再度同期し、要素がまだ存在する編集を保持します。セット全体をチェックし、1 回の元に戻す操作として適用します。適合しなくなった変更はスキップされ、トーストに示されます。却下と後では LML の提案と同じように動作し、ロール、有効期限(7 日)、保持期間も同様です(AI クライアントからの提案を参照)。

Systems Modeling API

他の SysML v2 ツールは、OMG Systems Modeling API(REST/HTTP)の形式のルートを通じて Holarch のモデルを読み取り、変更します。ベースアドレスは https://app.holarch.app/api/v1/sysml です。同じトークンを使います。どのプロジェクトロールでも読み取りができ、編集者とオーナーはコミットできます。

  • プロジェクト:SysML v2 プロジェクトだけが一覧表示されます。プロジェクトの @id は、この API が付ける UUID です。Holarch のプロジェクト ID も使えます。応答には holarchId と url が含まれます。
  • ブランチ:main はライブモデルで、API からは変更できません。それ以外のすべてのブランチは進行中の変更要求で、「CR-12 Title」という名前を持ち、holarchChangeRequest(id、label、status、url)を持ちます。過去 30 日以内に実施または取り下げられた変更要求も、deleted が設定された状態で一覧表示されます。
  • コミット:コミットは、変更要求のブランチに変更を書き込みます。提供されるのはブランチのヘッドだけです。main のヘッドはライブモデルで、変更要求ブランチのヘッドは、ライブモデルにその要求の変更を加えたものです。古いコミット ID には 404 が返されます。現在のヘッドはブランチから取得します。
  • 要素:各要素は、OMG JSON スキーマにおけるそのメタクラスのすべてのプロパティを、派生プロパティ(owner、ownedElement、qualifiedName、feature、type など)も含めて持ちます。標準ライブラリの要素は標準 ID で参照されます。これは、他の SysML v2 ツールが同じライブラリ要素に使う ID です。
  • タグと保存済みクエリ:ありません。それらの一覧は空です。
メソッドとパス機能
GET /sysml/projects自分の SysML v2 プロジェクト
POST /sysml/projects空の SysML v2 プロジェクトを作成します(name、description)
GET /sysml/projects/<projectId>1 つのプロジェクトと、その既定のブランチ
GET /sysml/projects/<projectId>/branchesmain と変更要求のブランチ
POST /sysml/projects/<projectId>/branchesブランチを作成します:新しい下書きの変更要求(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ブランチがライブモデルに対して変更する内容:要素ごとに 1 つの DataVersion
GET /sysml/projects/<projectId>/commits/<commitId>/elementsコミットのすべての要素(ページ分割)
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId>1 つの要素
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(property、operator(=、in、<、<=、>、>=、instanceOf)、value、inverse を持つ PrimitiveConstraint、または operator and か or と constraint を持つ CompositeConstraint)、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. ブランチを作成します:{"@type": "Branch", "name": "Cabin heater"} を付けて POST /branches。応答は、holarchChangeRequest を持つブランチです。
  2. ブランチのヘッドとその要素を読み取ります。
  3. DataVersion のリストを付けて POST /commits?branchId=<branch @id>:
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 は、要素をそれが所有するすべてのものとともに除去します。
  • チェック:コミットが触れる各パッケージは、出力して再び解析できる必要があり、コミットはエラーの診断を加えてはなりません。そうでない場合は、修正すべき diagnostics とともに 422 が返されます。
  • previousCommit:変更の基になったヘッド。それ以降にブランチが進んでいる場合、応答は現在の head を含む 409 stale-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 が返されます。エラーは、OMG API の定義どおり、@type Error と description を持ちます。

メッセージ

API と MCPのコードが適用されます。SysML v2 のルートとツールでは、次のものが加わります:

コードステータス意味
wrong-project-type409SysML v2 プロジェクトでの LML の操作、または LML プロジェクトでの SysML v2 の操作
syntax422提案されたテキストに構文エラーがあります。診断に行と列が示されます
invalid-model422変更がモデルにエラーの診断を加えます。それらが一覧表示されます
not-printable422変更を SysML テキストとして書き出せません
invalid422変更をモデルに適用できませんでした
no-change400テキストはモデルを変更しません
too-large413テキストが 1,000,000 文字を超えているか、提案が 8 MB を超えています
too-many413 または 4091 回の呼び出しで 100 件を超える編集(413)、または提案にすでに 200 件の変更がある(409)
stale409提案の以前のテキスト変更が、もうモデルに適用できません
not-found404該当するプロジェクト、要素、ブランチ、コミットがありません(Systems Modeling API はブランチのヘッドだけを提供します)
not-writable405Systems Modeling API によるタグ、マージ、プロジェクトの名前変更や削除。Holarch で行ってください
main-protected405main の削除。代わりに変更要求のブランチを削除してください
stale-head409previousCommit 以降にブランチが進んでいます。その head を読み取り、再度コミットしてください
branch-base409新しいブランチは main のヘッドから始める必要があります
branch-review-off409プロジェクトはブランチレビューを使用していません。オーナーが 変更要求 → 設定 でオンにします
cr-not-draft409変更要求は提出済みか、クローズされています。書き込めるのは下書きまたは却下の状態の間だけです
cr-full409変更要求に 5,000 件の変更された項目がある、またはプロジェクトに 20 MB の変更要求の下書きがあります
plan-limit403変更要求への書き込みには Team プランが必要です
orphan422新しい要素に所有者がありません。その所有メンバーシップまたは owner を送信してください
unknown-metaclass422ペイロードの @type が SysML v2 のメタクラスではありません
idempotency-key-reused422Idempotency-Key が別の本文で使われました。新しいキーを送信してください
token-projects403プロジェクトの一覧に限定されたトークンでは、プロジェクトを作成できません
bad-request400値がないか誤っています。たとえば、最上位パッケージではない root、不明な op、名前のない新しい要素など

制限事項

対象制限
1 ページあたりの要素、要求、接続500
要素とともに一覧表示されるメンバー200
1 回の応答あたりの診断500
1 回の応答あたりの SysML テキストの行数5,000 行、最大 400,000 バイト(行の区切りで切り詰め)
doc のテキスト一覧では 4,000 文字、1 つの要素では 20,000 文字
要素自体の SysML テキスト16,000 文字
1 回の propose_sysml 呼び出しのテキスト1,000,000 文字
1 回の呼び出しの編集100
1 つの変更で追加、変更、除去として一覧表示される要素それぞれ 300
1 つの提案の変更200 件、および 8 MB
Systems Modeling API のページ1,000 要素(既定 100)
1 回のコミットの DataVersion5,000
1 つの変更要求の変更された項目5,000
コミットの本文32 MB

レート制限、リクエストのサイズ、トークンのルールは、API と MCPと同じです。

SysML® および OMG® は、米国およびその他の国における Object Management Group, Inc. の登録商標です。