SysML v2
La API y MCP en proyectos SysML v2
Lea, busque y compruebe modelos SysML v2 desde scripts y herramientas de IA con un token de acceso personal, proponga cambios que usted revisa y aplica en Holarch, y lea y confirme cambios a través de la Systems Modeling API, donde las ramas son solicitudes de cambio.
En esta página
Resumen
Los proyectos SysML v2 funcionan con la misma API REST, el mismo endpoint MCP y los mismos tokens de acceso personal que los proyectos LML. Los scripts y las herramientas de IA leen el modelo como elementos y texto SysML, comprueban el texto antes de cambiar nada y proponen cambios. Nada del modelo cambia hasta que una persona revisa la propuesta en Holarch y la aplica.
Tres vías de acceso:
- API REST:
https://app.holarch.app/api/v1/projects/<project>/…para scripts y paneles. Lee elementos, requisitos, diagnósticos y texto SysML, y añade cambios a una propuesta. - MCP:
https://app.holarch.app/mcppara herramientas de IA como Claude. Las herramientas SysML v2 leen, buscan y comprueban el modelo y proponen cambios. - Systems Modeling API:
https://app.holarch.app/api/v1/sysml/…, con las formas de la OMG Systems Modeling API para otras herramientas SysML v2. La ramamaines el modelo activo y es de solo lectura; cualquier otra rama es una solicitud de cambio, y las confirmaciones van a ella. El modelo activo solo cambia cuando un aprobador aplica la solicitud de cambio en Holarch.
Los tokens, los ámbitos, las listas de proyectos, el cambio de organización, los límites de frecuencia y la conexión de Claude son iguales que para los proyectos LML. Consulte API y MCP para crear un token y conectar una herramienta de IA. Las llamadas del Mapa del programa (GET /api/v1/program-map, GET /api/v1/projects/<project>/items/<item>/trace, y las herramientas MCP program_map y trace_chain) incluyen los proyectos SysML v2 y sus elementos.
Conceptos
- Elemento: un componente del modelo SysML v2, como una definición de parte, un puerto o un requisito. Cada elemento tiene un id (un UUID). Siempre que una ruta o herramienta pida un id, también sirve un nombre calificado como
Vehicles::Car::powertrain. - Resumen: la forma breve de un elemento en las listas:
id,type(la metaclase, comoPartUsage),name,shortName,qualifiedNameyowner. - Paquete de nivel superior: un paquete que no está dentro de otro elemento. El texto SysML de un proyecto es un texto por paquete de nivel superior, más un texto para los elementos fuera de paquetes.
- Diagnóstico: un problema que encuentra el núcleo del lenguaje, con
code,severity(errorowarning),elementId,elementyargs. Los diagnósticos de sintaxis danlineycolen lugar de un elemento. - Propuesta: los cambios que un cliente de la API o una herramienta de IA reúne para su revisión. Hay una propuesta abierta por token y proyecto. El cliente la envía a revisión con un título y un resumen.
- Respuestas paginadas: las listas llegan en páginas (
limit,offset). El texto SysML largo llega en páginas de líneas (line,lines). Una respuesta que omitió algo indicatruncated: true.
Cómo usarlo
Use la API cuando un script o una herramienta de IA necesite el modelo: para informar de requisitos sin elementos que los satisfagan o verifiquen, para comprobar el texto SysML de un equipo frente al modelo o para que una herramienta de IA redacte cambios del modelo que luego revisa un ingeniero.
Leer un proyecto SysML v2 con curl
- Cree un token en Ajustes de la cuenta → Tokens de API (consulte API y MCP).
- Liste sus proyectos:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/projects
Los proyectos SysML v2 tienen "language": "sysml2".
- Obtenga el resumen del modelo:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/projects/<project>/model
Verá los recuentos de elementos por metaclase, los paquetes de nivel superior y el número de errores y advertencias.
- Busque elementos, por ejemplo todas las definiciones de parte:
curl -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/projects/<project>/elements?type=part%20def&limit=100"
- Lea el texto SysML de un paquete:
curl -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/projects/<project>/sysml?root=Vehicles"
Un texto largo termina con "truncated": true y "next": la línea que debe pedirse a continuación con line.
Comprobar texto SysML antes de proponerlo
- Envíe el nuevo texto de un paquete a la ruta de comprobación:
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
- Lea la respuesta.
okestruecuando el texto no tiene errores de sintaxis.diagnosticsenumera los errores de sintaxis conlineycol, y los errores que el texto añadiría al modelo.changeses el número de cambios en el modelo que produce el texto.
La comprobación no cambia nada. Solo necesita un token de lectura.
Proponer un cambio y aplicarlo
Un token de escritura añade cambios a la propuesta abierta del token. Después, el cliente envía la propuesta a revisión.
- Añada un cambio. Envíe el texto nuevo completo de un paquete o ediciones de elementos:
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
Recibirá 201 con la propuesta, el resumen del cambio y los elementos que añade, cambia y quita. Un cambio que añade diagnósticos de error se rechaza (consulte Propuestas en proyectos SysML v2).
- Añada más cambios de la misma forma. Cada cambio se comprueba frente al modelo con los cambios anteriores de la propuesta aplicados.
- Envíe la propuesta a revisión:
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
- En Holarch, abra el proyecto y luego ✦ IA ▾ → Revisar «Add range attribute»… (o la notificación bajo la campana).
- Compruebe las filas y haga clic en Aplicar seleccionados.
Los cambios marcados se aplican con su nombre en el historial, y un solo Deshacer lo revierte todo.
Conectar una herramienta de IA a un proyecto SysML v2
- Conecte la herramienta de IA a
https://app.holarch.app/mcpcon un token o con inicio de sesión (consulte API y MCP). - Pregunte sobre el modelo, por ejemplo «Resume el modelo Hybrid Car en Holarch» o «¿Qué requisitos del proyecto Hybrid Car no están verificados?».
La herramienta de IA usa
model_summary,list_elements,list_requirementsy las demás herramientas de lectura. - Pida un cambio, por ejemplo «Propón un atributo
rangeenCar».La herramienta de IA lee el paquete con
get_sysml, propone texto o ediciones de elementos y corrige los diagnósticos que devuelva la comprobación. - Revise la propuesta en Holarch y haga clic en Aplicar seleccionados.
Ejemplo práctico: la demostración Hybrid Car
Cree la demostración con Gestionar proyectos → Archivos de proyecto ▾ → Nuevo proyecto de demostración → Hybrid Car (SysML v2) y cree un token de lectura y escritura para ella.
GET /api/v1/projects/<project>/modelenumera los paquetes de nivel superior, entre ellosVehicles,HybridCarArchitectureyVehicleBehavior.GET /api/v1/projects/<project>/elements?query=Engine&type=part%20defencuentraVehicles::Engine.GET /api/v1/projects/<project>/elements/Vehicles::Enginedevuelve la definición de parte con su texto SysML, sus miembros (displacement,cylinders,maxPower, los puertosfuelIn,outputyecu) y los usos tipificados por ella.GET /api/v1/projects/<project>/elements/Vehicles::Car/connectionsmuestra la interfazdriveShaftdepowertrain.outputafrontAxle.input.GET /api/v1/projects/<project>/requirements?status=unverifiedenumera los requisitos que ningún caso de verificación verifica, con sus ids comoVR-4.1.POST /api/v1/projects/<project>/proposal/changescon{"edits": [{"op": "update", "id": "Vehicles::Engine", "doc": "Gasoline engine of the hybrid powertrain."}]}añade el cambio a la propuesta.POST /api/v1/projects/<project>/proposalcon un título la envía.- En Holarch, ✦ IA ▾ → Revisar «…» muestra Cambiado: con la definición de parte y el campo
doc, y la diferencia de texto deVehicles. Aplicar seleccionados la aplica.
Consejos
- Lea un paquete con
get_sysml(oGET …/sysml?root=) antes de proponer texto nuevo para él. Los elementos que no figuren en el texto propuesto se quitan. - Prefiera las ediciones de elementos para cambios pequeños. Solo cambian los elementos nombrados y dejan el resto del texto del paquete como está.
- Compruebe primero el texto con
check_sysml(oPOST …/sysml/check). Devuelve los mismos diagnósticos con los que se rechazaría una propuesta. - En los scripts, nombre los elementos por su nombre calificado. Los ids no cambian cuando se cambia el nombre de un elemento; los nombres calificados, sí.
- Dé a una herramienta de IA un token de solo lectura cuando solo responda preguntas sobre el modelo.
Rutas REST para proyectos SysML v2
Dirección base: https://app.holarch.app/api/v1. Las respuestas son JSON. /api/v1/openapi.json (OpenAPI 3.1) describe estas rutas junto con las demás.
| Método y ruta | Qué hace |
|---|---|
GET /projects/<project>/model | Recuentos de elementos por metaclase, los paquetes de nivel superior con sus recuentos de elementos y el número de errores y advertencias |
GET /projects/<project>/elements | Búsqueda: query (o q; texto en el nombre, el nombre corto, el nombre calificado o la documentación), type, owner, limit (1–500, 50 de forma predeterminada), offset; ordenado por nombre calificado |
GET /projects/<project>/elements/<id> | Un elemento con sus campos, documentación, texto SysML, miembros y los usos tipificados por él; members (0–200, 100 de forma predeterminada) |
GET /projects/<project>/elements/<id>/connections | Conexiones, interfaces, enlaces, flujos (con el ítem), sucesiones, transiciones, asignaciones y dependencias en el elemento o en sus características, y las que posee en su interior; limit (100 de forma predeterminada) |
GET /projects/<project>/requirements | Requisitos con su id, enunciado (doc), satisfiedBy y verifiedBy; owner, status (unsatisfied o unverified), limit (100 de forma predeterminada), offset |
GET /projects/<project>/diagnostics | Los diagnósticos del modelo, primero los errores; ids (separados por comas: solo esos elementos y sus miembros), limit (200 de forma predeterminada, 500 como máximo) |
GET /projects/<project>/sysml | Texto SysML de un paquete de nivel superior (root), de los elementos fuera de paquetes (sin root) o de un elemento (element); line (primera línea, desde 1), lines (2000 de forma predeterminada, 5000 como máximo) |
POST /projects/<project>/sysml/check | Comprobar text como nuevo texto de root (o de los elementos fuera de paquetes); no cambia nada |
POST /projects/<project>/proposal/changes | Añadir un cambio a la propuesta abierta: {text, root} o {edits} |
GET /projects/<project>/proposal | La propuesta abierta, o una por su id de proposal, con su estado y sus cambios |
POST /projects/<project>/proposal | Enviar la propuesta abierta a revisión: title, summary |
DELETE /projects/<project>/proposal | Descartar la propuesta abierta antes de enviarla |
GET /projects y GET /projects/<project> también funcionan para proyectos SysML v2. Dan "language": "sysml2", y la respuesta del proyecto añade elements y types (recuentos de elementos por metaclase).
Las rutas de entidades LML (/entities, /relationships, /schema, Comprobaciones del modelo y la comprobación de calidad) responden 409 wrong-project-type en un proyecto SysML v2. Las rutas SysML v2 responden lo mismo en un proyecto LML.
Valores
- type: una metaclase como
PartUsageoRequirementDefinition, o una palabra clave tal como se escribe en el texto SysML:part,part def,attribute,port,requirement,action,packagey las demás palabras clave de elementos. - owner, id, element, root: un id o un nombre calificado.
roottambién admite el nombre de un paquete de nivel superior.rootdebe ser un paquete de nivel superior; para leer el texto de un elemento, useelement. - Valores largos: una documentación en una lista se corta a los 4,000 caracteres, la documentación de un solo elemento a los 20,000, y el texto SysML propio de un elemento a los 16,000 caracteres.
Herramientas MCP para proyectos SysML v2
El endpoint MCP enumera estas herramientas junto a las herramientas LML. Una herramienta de IA encuentra los proyectos SysML v2 con list_projects (language: sysml2). Todas las herramientas admiten project.
Las herramientas de lectura también admiten un change_request opcional (CR-12 o su id) para leer el modelo tal como lo dejaría esa solicitud de cambio; propose_sysml y propose_element_changes admiten uno para calcular el cambio frente al modelo de la solicitud y aplicarlo a ese borrador tras la revisión. Consulte Solicitudes de cambio para conocer las reglas.
| Herramienta | Acceso | Qué hace |
|---|---|---|
model_summary | Lectura | Recuentos de elementos por metaclase, los paquetes de nivel superior y el número de diagnósticos |
list_elements | Lectura | Buscar elementos por texto (query), type y owner; paginado con limit y offset |
get_element | Lectura | Un elemento (id) con sus tipos, especializaciones, multiplicidad, valor, extremos, documentación, texto SysML, miembros (members, 200 como máximo) y los usos tipificados por él |
get_connections | Lectura | Las conexiones, interfaces, enlaces, flujos, sucesiones, transiciones, asignaciones y dependencias de un elemento (id, limit) |
list_requirements | Lectura | Requisitos con su id, enunciado, satisfy y verify; owner, status (unsatisfied, unverified), limit, offset |
get_sysml | Lectura | Texto SysML de un paquete de nivel superior (root), de los elementos fuera de paquetes o de un elemento (element); line, lines (5000 como máximo); la respuesta da next |
get_sysml_text | Lectura | Texto SysML de todo el modelo (cada paquete de nivel superior y luego los elementos fuera de paquetes) o de un package, hasta 200,000 caracteres por respuesta; la respuesta nombra los paquetes omitidos |
check_sysml | Lectura | Sin text: los diagnósticos del modelo (ids, limit). Con text (y root): errores de sintaxis con línea y columna, y los errores que el texto añadiría. No cambia nada |
propose_sysml | Lectura y escritura | Proponer el text nuevo completo de un paquete de nivel superior (root) o de los elementos fuera de paquetes (sin root; también donde va un paquete nuevo) |
propose_element_changes | Lectura y escritura | Proponer edits (100 como máximo) sin reescribir texto: crear, actualizar, mover o quitar |
list_diagrams, get_diagram y get_matrix también funcionan en proyectos SysML v2: list_diagrams enumera las vistas (con su tipo, como InterconnectionView) y los diagramas de análisis guardados bajo un elemento; get_diagram da los elementos que expone una vista después de sus filtros (por id de elemento o nombre calificado); get_matrix da cada requisito con lo que lo satisface y lo verifica.
Las herramientas de propuestas de los proyectos LML funcionan aquí de la misma forma: propose_changes envía la propuesta con un título y un resumen, discard_proposal la descarta, y get_proposal y list_proposals muestran su estado. Un token de solo lectura enumera solo las herramientas de lectura.
Los errores de las herramientas vuelven como resultado de la herramienta con el mensaje y los diagnósticos, para que la herramienta de IA pueda corregir su texto e intentarlo de nuevo.
Ediciones de elementos
Cada edición de edits (MCP) o {"edits": […]} (REST) es un objeto con op:
| op | Campos |
|---|---|
create | kind (una palabra clave como part, part def, attribute, port, requirement, action, package) o type (una metaclase); owner (si se omite: nivel superior); name (obligatorio); opcionales shortName, typedBy, specializes, subsets, redefines, multiplicity, value, doc, direction (in, out, inout) |
update | id y los campos que se van a cambiar, como en create; null o "" vacía un campo |
move | id y el nuevo owner |
remove | id; quita el elemento con sus miembros |
typedBy,specializes,subsetsyredefinesson listas de hasta 20 nombres: ids, nombres calificados o nombres tal como se escriben en el texto (funcionan nombres de biblioteca comoMassValue).- Las ediciones posteriores pueden nombrar los elementos creados antes en la misma llamada como
new:1,new:2… en el orden en que se crearon, por ejemplo comoowner. La respuesta los enumera encreatedcon sus nuevos ids. - Cambiar el nombre de un elemento también actualiza las referencias que lo nombraban por su nombre anterior.
Texto propuesto
propose_sysmlsustituye todo el texto del paquete. Los elementos conservan sus ids donde el texto todavía los declara. Los elementos que no figuran en el texto se quitan.- El texto debe analizarse sin errores y sin que quede nada sin aplicar. El texto que no cambia el modelo se rechaza (
no-change).
Propuestas en proyectos SysML v2
El núcleo del lenguaje comprueba cada cambio propuesto antes de que se una a la propuesta:
- El texto se analiza sin errores de sintaxis, y las ediciones de elementos se aplican.
- Los paquetes cambiados todavía se imprimen como texto SysML y se vuelven a analizar.
- El cambio no añade diagnósticos de error al modelo, como nombres sin resolver o errores de tipo. Los errores que el modelo ya tenía no cuentan.
Un cambio que falla se rechaza con los diagnósticos (hasta 50) que hay que corregir. No se guarda nada. Las advertencias no rechazan un cambio.
Proponer requiere un token de lectura y escritura y el rol de editor o propietario en el proyecto. Una propuesta contiene como máximo 200 cambios y 8 MB.
Revisar una propuesta SysML v2
Abra el proyecto y luego ✦ IA ▾ → Revisar «<title>»…. Cada cambio es una fila con una casilla:
- Añadido, Cambiado y Quitado enumeran los elementos, con los campos cambiados (los 20 primeros de cada uno; «y n más» para el resto).
- Una diferencia de texto, etiquetada con el paquete, muestra el texto SysML antes y después.
- Un cambio que quita elementos se señala y empieza desmarcado.
- Abra el modelo SysML v2 para aplicar este cambio. El modelo no está cargado; abra una página SysML v2 del proyecto.
- El paquete ya no está en el modelo; omitido. El paquete se quitó después de proponer el cambio.
Aplicar seleccionados vuelve a sincronizar cada cambio de texto con el modelo actual y conserva las ediciones cuyos elementos aún existen. Comprueba todo el conjunto y lo aplica como un paso de deshacer. Los cambios que ya no encajan se omiten y se nombran en un aviso. Rechazar y Más tarde funcionan como en las propuestas LML, al igual que los roles, la caducidad (7 días) y la conservación (consulte Propuestas de clientes de IA).
Systems Modeling API
Otras herramientas SysML v2 leen y cambian modelos de Holarch mediante rutas con las formas de la OMG Systems Modeling API (REST/HTTP). La dirección base es https://app.holarch.app/api/v1/sysml. Usa los mismos tokens; cualquier rol del proyecto puede leer, y los editores y propietarios pueden confirmar cambios.
- Proyectos: solo se enumeran los proyectos SysML v2. El
@idde un proyecto es un UUID que le asigna esta API; el id de proyecto de Holarch también funciona. La respuesta incluyeholarchIdyurl. - Ramas:
maines el modelo activo y no se puede cambiar mediante la API. Cualquier otra rama es una solicitud de cambio en curso, llamada «CR-12 Título» y conholarchChangeRequest(id,label,status,url). Las solicitudes de cambio implementadas o retiradas en los últimos 30 días siguen apareciendo, condeletedestablecido. - Confirmaciones: una confirmación escribe cambios en la rama de una solicitud de cambio. Solo se sirven los heads de las ramas: el head de
maines el modelo activo; el head de la rama de una solicitud de cambio es el modelo activo con los cambios de la solicitud. Los ids de confirmaciones anteriores responden404; obtenga el head actual a partir de la rama. - Elementos: cada elemento tiene todas las propiedades de su metaclase en el esquema JSON de OMG, incluidas las derivadas (
owner,ownedElement,qualifiedName,feature,typey similares). Los elementos de la biblioteca estándar se referencian por sus ids estándar, los mismos ids que usan otras herramientas SysML v2 para el mismo elemento de biblioteca. - Etiquetas y consultas guardadas: ninguna; sus listas están vacías.
| Método y ruta | Qué hace |
|---|---|
GET /sysml/projects | Sus proyectos SysML v2 |
POST /sysml/projects | Crear un proyecto SysML v2 vacío (name, description) |
GET /sysml/projects/<projectId> | Un proyecto, con su rama predeterminada |
GET /sysml/projects/<projectId>/branches | main y las ramas de solicitudes de cambio |
POST /sysml/projects/<projectId>/branches | Crear una rama: una nueva solicitud de cambio en borrador (name es su título, description su motivo) |
GET /sysml/projects/<projectId>/branches/<branchId> | La rama (su @id o main), con head |
DELETE /sysml/projects/<projectId>/branches/<branchId> | Retirar la solicitud de cambio |
GET /sysml/projects/<projectId>/commits | Los heads y las confirmaciones enviadas a las ramas, de la más reciente a la más antigua |
POST /sysml/projects/<projectId>/commits?branchId=<branchId> | Confirmar cambios en una rama (véase más abajo) |
GET /sysml/projects/<projectId>/commits/<commitId> | Una confirmación head |
GET /sysml/projects/<projectId>/commits/<commitId>/changes | Lo que la rama cambia frente al modelo activo: un DataVersion por elemento |
GET /sysml/projects/<projectId>/commits/<commitId>/elements | Todos los elementos de la confirmación, paginados |
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId> | Un elemento |
GET /sysml/projects/<projectId>/commits/<commitId>/roots | Los elementos de nivel superior, paginados |
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId>/relationships | Las relaciones que tienen el elemento como origen o destino; direction es in, out o both (predeterminado), paginadas |
POST /sysml/projects/<projectId>/query-results | Los elementos que coinciden con una consulta (cuerpo más abajo), paginados; commitId debe ser un head |
GET /sysml/projects/<projectId>/tags, /queries, /commits/<commitId>/elements/<elementId>/projectUsages | Listas vacías |
Las respuestas de lista son arrays JSON. Las listas se paginan con page[size] (100 de forma predeterminada, 1000 como máximo) y page[after] (el @id del último elemento de la página anterior) o page[before] (el @id del primer elemento de la página siguiente). La cabecera Link da la página siguiente con rel="next" y la anterior con rel="prev".
Una consulta es un objeto JSON con un where opcional (un PrimitiveConstraint con property, operator (=, in, <, <=, >, >= o instanceOf), value e inverse, o un CompositeConstraint con operator and u or y constraint), scope (ids de elementos: la búsqueda los abarca a ellos y lo que poseen) y select (las propiedades que se devuelven; @id y @type siempre se devuelven):
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"]}'
Leer los elementos de un modelo:
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"
Confirmar cambios
Escribir requiere un token con acceso de lectura y escritura, el rol de editor o propietario, el plan Team (también para cuentas académicas y de clase) y la revisión de ramas activada en el proyecto (Solicitudes de cambio → Ajustes). Un aprobador revisa y aplica la solicitud de cambio en Holarch; los tokens nunca votan ni aplican.
- Cree una rama: POST
/branchescon{"@type": "Branch", "name": "Cabin heater"}. La respuesta es la rama con suholarchChangeRequest. - Lea el head de la rama y sus elementos.
- POST
/commits?branchId=<branch @id>con una lista deDataVersion:
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>"}}}]}'
- Cambiar un elemento: envíe el elemento tal como lo leyó, con las propiedades cambiadas. Solo cuentan las propiedades propias (
declaredName,ownedRelationship,isAbstracty similares); las derivadas se ignoran, de modo que devolver lo que leyó no cambia nada. Una propiedad que omita conserva su valor; envíenullo[]para vaciarla. - Elementos nuevos: dé al elemento un UUID nuevo y su membresía propietaria (enviada en la misma confirmación) o
owner, que crea la membresía por usted. - Quitar un elemento:
payload: nulllo quita con todo lo que posee. - Comprobaciones: cada paquete que toca la confirmación debe imprimirse y analizarse de nuevo, y la confirmación no debe añadir diagnósticos de error; de lo contrario,
422con losdiagnosticsque hay que corregir. - previousCommit: el head sobre el que se hizo su cambio. Si la rama ha avanzado desde entonces, la respuesta es
409stale-headcon elheadactual; lea de nuevo y confirme sobre él. - Reintentos: envíe una cabecera
Idempotency-Key. Un reintento con la misma clave y el mismo cuerpo en un plazo de 24 horas recibe de nuevo la primera respuesta. - Confirmaciones en
main: una confirmación sinbranchId, o conmain, va a la solicitud de cambio en borrador propia de su token («API changes from <token name>»), creada con la primera confirmación de este tipo. La respuesta indica cuál enholarchChangeRequesty en una cabeceraWarning. - Proyectos nuevos: un proyecto creado con POST
/sysml/projectstiene la revisión de ramas activada. Su primera confirmación enmain, mientras usted sea su único miembro, se escribe directamente en el modelo, una vez; las confirmaciones posteriores pasan por solicitudes de cambio.
Envíe la solicitud de cambio a revisión con POST /api/v1/projects/<project>/change-requests/<CR-12>/submit (API y MCP). Las etiquetas, las fusiones y el cambio de nombre o la eliminación de un proyecto responden 405 con lo que hay que hacer en su lugar. Los errores llevan @type Error y una description, tal como los define la API de OMG.
Mensajes
Se aplican los códigos de API y MCP. Las rutas y herramientas SysML v2 añaden:
| Código | Estado | Significado |
|---|---|---|
wrong-project-type | 409 | Una operación LML en un proyecto SysML v2, o una operación SysML v2 en un proyecto LML |
syntax | 422 | El texto propuesto tiene errores de sintaxis; los diagnósticos dan la línea y la columna |
invalid-model | 422 | El cambio añade diagnósticos de error al modelo; se enumeran |
not-printable | 422 | El cambio no se puede escribir como texto SysML |
invalid | 422 | No se pudo aplicar el cambio al modelo |
no-change | 400 | El texto no cambia el modelo |
too-large | 413 | El texto supera los 1,000,000 caracteres, o la propuesta supera los 8 MB |
too-many | 413 o 409 | Más de 100 ediciones en una llamada (413), o la propuesta ya contiene 200 cambios (409) |
stale | 409 | Un cambio de texto anterior de la propuesta ya no se aplica al modelo |
not-found | 404 | No existe ese proyecto, elemento, rama o confirmación (la Systems Modeling API solo sirve los heads de las ramas) |
not-writable | 405 | Etiquetas, fusiones, cambio de nombre o eliminación de un proyecto mediante la Systems Modeling API; hágalo en Holarch |
main-protected | 405 | Eliminar main; elimine en su lugar una rama de solicitud de cambio |
stale-head | 409 | La rama ha avanzado desde previousCommit; lea su head y confirme de nuevo |
branch-base | 409 | Una rama nueva debe partir del head de main |
branch-review-off | 409 | El proyecto no usa la revisión de ramas; un propietario la activa en Solicitudes de cambio → Ajustes |
cr-not-draft | 409 | La solicitud de cambio está enviada o cerrada; solo se puede escribir mientras está en Borrador o Rechazada |
cr-full | 409 | La solicitud de cambio contiene 5,000 elementos cambiados, o el proyecto 20 MB de borradores de solicitudes de cambio |
plan-limit | 403 | Las escrituras en solicitudes de cambio requieren el plan Team |
orphan | 422 | Un elemento nuevo no tiene propietario; envíe su membresía propietaria u owner |
unknown-metaclass | 422 | El @type de un payload no es una metaclase de SysML v2 |
idempotency-key-reused | 422 | La Idempotency-Key se usó con otro cuerpo; envíe una clave nueva |
token-projects | 403 | Un token limitado a una lista de proyectos no puede crear un proyecto |
bad-request | 400 | Un valor que falta o es incorrecto, como un root que no es un paquete de nivel superior, una op desconocida o un elemento nuevo sin nombre |
Límites
| Qué | Límite |
|---|---|
| Elementos, requisitos o conexiones por página | 500 |
| Miembros enumerados con un elemento | 200 |
| Diagnósticos por respuesta | 500 |
| Líneas de texto SysML por respuesta | 5,000, y como máximo 400,000 bytes (cortado en una línea) |
| Texto de documentación | 4,000 caracteres en listas, 20,000 para un elemento |
| El texto SysML propio de un elemento | 16,000 caracteres |
Texto en una llamada a propose_sysml | 1,000,000 caracteres |
| Ediciones en una llamada | 100 |
| Elementos enumerados como añadidos, cambiados o quitados en un cambio | 300 de cada uno |
| Cambios en una propuesta | 200, y 8 MB |
| Página de la Systems Modeling API | 1,000 elementos (100 de forma predeterminada) |
| DataVersions en una confirmación | 5,000 |
| Elementos cambiados en una solicitud de cambio | 5,000 |
| Cuerpo de la confirmación | 32 MB |
Los límites de frecuencia, el tamaño de las solicitudes y las reglas de los tokens son los de API y MCP.
Páginas relacionadas
- API y MCP
- Primeros pasos con proyectos SysML v2
- El editor de texto y el explorador
- Intercambio de modelos SysML v2
- Requisitos y verificación en proyectos SysML v2
SysML® y OMG® son marcas registradas de Object Management Group, Inc. en los Estados Unidos y otros países.