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 中评审并应用提议之前,模型中的任何内容都不会改变。

三种接入方式:

  • REST API:https://app.holarch.app/api/v1/projects/<project>/…,供脚本和仪表板使用。它读取元素、需求、诊断信息和 SysML 文本,并将更改添加到提议中。
  • MCP:https://app.holarch.app/mcp,供 AI 应用等 AI 工具使用。SysML v2 工具可读取、搜索和检查模型,并提出更改。
  • Systems Modeling API:https://app.holarch.app/api/v1/sysml/…,采用 OMG Systems Modeling API 的结构,供其他 SysML v2 工具使用。分支 main 是实时模型,且为只读;其他每个分支都是一个变更请求,提交会进入该分支。只有审批人在 Holarch 中应用变更请求时,实时模型才会改变。

令牌、作用域、项目列表、组织切换、速率限制以及连接 AI 应用的方式都与 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 模型中的一项内容,例如部件定义、端口或需求。每个元素都有一个 ID(UUID)。凡是路由或工具要求提供 ID 的地方,也可以使用限定名,例如 Vehicles::Car::powertrain。
  • 简要信息:元素在列表中的简短形式:id、type(元类,例如 PartUsage)、name、shortName、qualifiedName 和 owner。
  • 顶层包:不在其他元素内部的包。项目的 SysML 文本由每个顶层包各一段文本组成,外加一段包外元素的文本。
  • 诊断信息:语言核心发现的问题,带有 code、severity(error 或 warning)、elementId、element 和 args。语法诊断信息给出 line 和 col,而不是元素。
  • 提议:API 客户端或 AI 工具收集以供评审的更改。每个令牌和项目只有一个打开的提议。客户端会附上标题和摘要将其发送评审。
  • 分页响应:列表分页返回(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 ▾ → 评审“Add range attribute”…(或铃铛下的通知)。
  2. 检查各行,然后点击应用所选项。

    勾选的更改会被应用,历史记录中会显示您的名字,一次撤销即可全部撤回。

将 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 列出没有任何验证用例验证的需求,并附有其 ID,例如 VR-4.1。
  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 ▾ → 评审“…”会显示已更改:,其中包含该部件定义和字段 doc,以及 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>一个元素及其字段、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某个顶层包(root)、包外元素(不带 root)或单个元素(element)的 SysML 文本;line(起始行,从 1 开始)、lines(默认 2000,最多 5000)
POST /projects/<project>/sysml/check将 text 作为 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(每个元类的元素数量)。

在 SysML v2 项目中,LML 实体路由(/entities、/relationships、/schema、模型检查和质量检查)返回 409 wrong-project-type。在 LML 项目中,SysML v2 路由也返回同样的响应。

值

  • type:元类,例如 PartUsage 或 RequirementDefinition,或 SysML 文本中写法的关键字:part、part def、attribute、port、requirement、action、package 以及其他元素关键字。
  • owner、id、element、root:ID 或限定名。root 也接受顶层包的名称。root 必须是顶层包;要读取单个元素的文本,请使用 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读取一个元素(id)及其类型、特化、多重性、值、端点、doc、SysML 文本、成员(members,最多 200 个)和由它类型化的用法
get_connections读取元素(id、limit)的连接、接口、绑定、流、后继关系、转换、分配和依赖
list_requirements读取需求及其 ID、陈述、satisfy 和 verify;owner、status(unsatisfied、unverified)、limit、offset
get_sysml读取某个顶层包(root)、包外元素或单个元素(element)的 SysML 文本;line、lines(最多 5000);响应会给出 next
get_sysml_text读取整个模型(每个顶层包,然后是包外元素)或单个 package 的 SysML 文本,每次响应最多 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 和要更改的字段,与创建时相同;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 MB。

评审 SysML v2 提议

打开项目,然后打开 ✦ AI ▾ → 评审“<title>”…。每项更改都是一个带复选框的行:

  • 已添加、已更改和已移除列出各元素及其更改的字段(每类前 20 个;其余显示为“及另外 n 个”)。
  • 以包为标签的文本差异显示更改前后的 SysML 文本。
  • 移除元素的更改会被标记,并且初始为未勾选。
  • 打开 SysML v2 模型以应用此更改。模型未加载;请打开项目的某个 SysML v2 页面。
  • 该包已不在模型中;已跳过。该包在更改被提议之后已被移除。

应用所选项会将每项文本更改与当前模型重新同步,并保留其元素仍然存在的编辑。它会检查整组更改并将其作为一个撤销步骤应用。不再适用的更改会被跳过,并在提示消息中列出。拒绝和稍后的作用与 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>一个项目及其默认分支
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(一个带 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 会移除该元素及其拥有的一切。
  • 检查:提交涉及的每个包都必须能够再次打印和解析,且提交不得增加错误诊断信息;否则返回 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在 SysML v2 项目中执行 LML 操作,或在 LML 项目中执行 SysML v2 操作
syntax422提议的文本有语法错误;诊断信息给出行号和列号
invalid-model422该更改给模型增加了错误诊断信息;会列出这些信息
not-printable422该更改无法写成 SysML 文本
invalid422该更改无法应用到模型
no-change400该文本不改变模型
too-large413文本超过 1,000,000 个字符,或提议大于 8 MB
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变更请求包含 5,000 个已更改的条目,或项目包含 20 MB 的变更请求草稿
plan-limit403写入变更请求需要 Team 方案
orphan422新元素没有所有者;请发送其所属成员关系或 owner
unknown-metaclass422有效载荷的 @type 不是 SysML v2 元类
idempotency-key-reused422该 Idempotency-Key 已用于另一个请求体;请发送新的键
token-projects403仅限于一组项目的令牌无法创建项目
bad-request400缺少值或值错误,例如 root 不是顶层包、未知的 op,或新元素没有名称

限制

内容限制
每页的元素、需求或连接500
随元素列出的成员200
每次响应的诊断信息500
每次响应的 SysML 文本行数5,000 行,且最多 400,000 字节(在行边界截断)
Doc 文本列表中 4,000 个字符,单个元素 20,000 个字符
元素自身的 SysML 文本16,000 个字符
一次 propose_sysml 调用中的文本1,000,000 个字符
一次调用中的编辑数100
一项更改中列为已添加、已更改或已移除的元素每类 300 个
一个提议中的更改数200 项,且 8 MB
Systems Modeling API 页面1,000 个元素(默认 100)
一次提交中的 DataVersion 数5,000
一个变更请求中已更改的条目数5,000
提交请求体32 MB

速率限制、请求大小和令牌规则与 API 与 MCP 中的相同。

SysML® 和 OMG® 是 Object Management Group, Inc. 在美国和其他国家/地区的注册商标。