API-Referenz

Knoten mit ähnlichen Namen finden, die Duplikate sein könnten. Verwendet String-Ähnlichkeitsabgleich. Nützlich vor dem Erstellen neuer Knoten, um Duplizierung zu vermeiden.

3 parameter(s)

Ruft das Schema des Modells (Metamodell) ab. Liefert alle Knotentypen, Beziehungstypen, deren Eigenschaften, erlaubte Verbindungen und Instanzzahlen. Rufen Sie dies immer zuerst auf, um zu verstehen, was das Modell enthält. Bei Simulationsmodellen liefert es außerdem für jede Eigenschaft das „computed“-Kennzeichen und die Rhai-Formel sowie das act_script jedes Knotentyps, dazu einen selbstbeschreibenden „scripting“-Block, der die verfügbaren Simulationsfunktionen (get_connected, sum_prop, agent.get_prop/set_prop, …) dokumentiert, damit Sie Formeln korrekt schreiben können.

1 parameter(s)

Liefert vollständige Details zu einem oder mehreren Knoten anhand ihrer IDs. Gibt alle Eigenschaften, die Beschreibung und Metadaten zurück. Akzeptiert sowohl UUIDs als auch Auto-IDs (z. B. REQ-42). Jeder Knoten enthält außerdem einen updated_at-Zeitstempel (ISO 8601 UTC), der angibt, wann er zuletzt geändert wurde – so können externe Tools Knoten überspringen, die sich seit dem letzten Abruf nicht geändert haben.

2 parameter(s)

Beziehungen (Verbindungen) zwischen Knoten finden. Filtern nach Beziehungstyp, Quellknoten, Zielknoten oder Knotentypen. Quell- und Ziel-IDs akzeptieren sowohl UUIDs als auch Auto-IDs (z. B. REQ-42).

7 parameter(s)

Modellweite Statistiken abrufen: Knoten- und Beziehungsanzahlen nach Typ, am stärksten verbundene Knoten und Eigenschaftsvollständigkeit. Nützlich für einen schnellen Modellüberblick.

1 parameter(s)

Sucht nach Knoten (Instanzen) im Modell. Filtern Sie nach Typ, Name, Beschreibung, Eigenschaftswerten oder Ordner. Gibt Zusammenfassungen zurück – für vollständige Informationen verwenden Sie get_node_details. Jede Zusammenfassung enthält jetzt einen updated_at-Zeitstempel (ISO 8601 UTC) zur Änderungserkennung.

8 parameter(s)

Ein erlaubtes Verbindungsmuster zwischen Knotentypen für einen Beziehungstyp definieren. Alle drei (Beziehungstyp, Quell-Knotentyp, Ziel-Knotentyp) müssen bereits im Metamodell existieren. Verwenden Sie get_metamodel, um vorhandene Typen zu prüfen.

Fügt dem Metamodell einen neuen Knotentyp (Entitätstyp) hinzu. Tun Sie dies, bevor Sie Knoten dieses Typs erstellen. Sie können eigene Eigenschaften mit Datentypen definieren. Für die Simulation kann eine Eigenschaft als „computed“ markiert werden (ihr default_value ist dann eine bei jedem Zeitschritt ausgewertete Rhai-Formel), und der Knotentyp kann ein act_script tragen – ein Rhai-Skript, das pro Agent und Zeitschritt ausgeführt wird und das Verhalten steuert.

Einen neuen Beziehungstyp zum Metamodell hinzufügen. Verwenden Sie nach dem Erstellen add_allowed_connection, um festzulegen, welche Knotentypen damit verbunden werden können.

Alle Beziehungen zwischen bereits auf einem Diagramm platzierten Elementen automatisch anzeigen. Für Modelldiagramme werden M1-Beziehungen angezeigt; für Metamodell-Diagramme erlaubte Verbindungen. Wird sofort angewendet.

Knoten oder Knotentypen mit automatischem Rasterlayout zu einem Diagramm hinzufügen. Für Modelldiagramme verwenden Sie Knoten-IDs oder Auto-IDs (z. B. REQ-1); für Metamodell-Diagramme verwenden Sie Knotentyp-IDs. Wird sofort angewendet.

Ein neues Diagramm zur Visualisierung von Modellelementen erstellen. Verwenden Sie den Diagrammtyp „metamodel" für M2-Typ-Diagramme, „model" für M1-Instanz-Diagramme. Wird sofort angewendet.

Einen gespeicherten Filter mit einem kombinierbaren Ausdruck erstellen. Ausdrücke: {"OfType":{"type_id":"<id>"}}, {"HasTag":{"tag":"foo"}}, {"NameMatches":{"operator":"Contains","value":"foo"}}, {"And":[...]}, {"Or":[...]}, {"Not":expr}, {"InFolder":{"folder_id":"<id>","recursive":true}} oder "All". Wird sofort angewendet.

Einen neuen Ordner zum Organisieren von Modellelementen erstellen. Verwenden Sie die Ebene „metamodel" für Knoten-/Beziehungstyp-Ordner, „model" für Knoten-/Beziehungs-/Diagramm-Ordner. Wird sofort angewendet.

Neue Knoteninstanzen erstellen. Der Knotentyp muss bereits im Metamodell existieren (verwenden Sie get_metamodel zum Prüfen oder add_node_type zum Erstellen). Änderungen werden sofort angewendet und in Echtzeit an alle verbundenen Browser-Benutzer übertragen.

3 parameter(s)

Beziehungen zwischen vorhandenen Knoten erstellen. Sowohl Quelle als auch Ziel müssen existieren. Der Beziehungstyp muss im Metamodell existieren und eine erlaubte Verbindung für die angegebenen Quell-/Ziel-Knotentypen haben.

Ein Diagramm und alle seine Elementplatzierungen löschen. Löscht NICHT die zugrunde liegenden Knoten oder Beziehungen — nur die visuelle Darstellung. Wird sofort angewendet.

Einen gespeicherten Filter löschen. Löscht keine Modelldaten. Wird sofort angewendet. Akzeptiert Filter-ID oder Name.

Einen oder mehrere Knoten löschen. Standardmäßig werden auch alle verbundenen Beziehungen gelöscht (Kaskade). Setzen Sie cascade_relationships auf false, damit die Operation fehlschlägt, wenn der Knoten Beziehungen hat.

2 parameter(s)

Eine oder mehrere Beziehungen anhand ihrer IDs löschen. Verwenden Sie get_relationships, um die Beziehungs-IDs zuerst zu finden.

Doppelte Knoten zu einem einzelnen Knoten zusammenführen. Alle Beziehungen der zusammengeführten Knoten werden auf den beibehaltenen Knoten umgeleitet. Die zusammengeführten Knoten werden dann gelöscht. Verwenden Sie find_similar_nodes, um Kandidaten zu identifizieren.

1 parameter(s)

Modellelemente in einen Ordner verschieben (oder zum Stammverzeichnis durch Weglassen der folder_id). Unterstützt Knoten, Beziehungen, Knotentypen, Beziehungstypen, Diagramme und Ordner. Wird sofort angewendet.

Eine erlaubte Verbindungseinschränkung entfernen, wodurch die Berechtigung für einen Beziehungstyp zum Verbinden bestimmter Knotentyp-Paare widerrufen wird. Wird sofort angewendet.

Knoten oder Knotentypen aus einem Diagramm entfernen. Entfernt auch verbundene Beziehungsvisualisierungen in diesem Diagramm. Löscht NICHT die zugrunde liegenden Elemente. Wird sofort angewendet.

Einen Knotentyp aus dem Metamodell entfernen. Kaskadiert auch die Entfernung aller M1-Instanzen dieses Typs und ihrer Beziehungen. Wird sofort angewendet. Mit Vorsicht verwenden — kann über MCP nicht rückgängig gemacht werden.

Einen Beziehungstyp aus dem Metamodell entfernen. Entfernt auch alle Beziehungen dieses Typs aus M1. Wird sofort angewendet. Mit Vorsicht verwenden.

Einen vorhandenen Ordner umbenennen und optional seine Beschreibung aktualisieren. Wird sofort angewendet.

Name oder Beschreibung eines vorhandenen Diagramms aktualisieren. Wird sofort angewendet. Akzeptiert Diagramm-ID oder Name.

Den übergeordneten Namen oder die Beschreibung des Modells aktualisieren. Wird sofort angewendet.

Aktualisiert einen bestehenden Knotentyp: umbenennen, umfärben, Beschreibung ändern oder neue Eigenschaften hinzufügen. Für die Simulation setzt oder löscht set_act_script das Rhai-act_script des Knotentyps, und update_properties bearbeitet bestehende Eigenschaften direkt – einschließlich, eine Eigenschaft „computed“ zu machen oder ihre Rhai-Formel zu ändern. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Labels, Beschreibungen oder Eigenschaften vorhandener Knoten aktualisieren. Verwenden Sie set_label/set_description für Kernfelder, set_properties für Schlüssel-Wert-Paare und remove_properties zum Löschen von Werten. Knoten-IDs akzeptieren sowohl UUIDs als auch Auto-IDs (z. B. REQ-42).

1 parameter(s)

Einen vorhandenen Beziehungstyp aktualisieren: umbenennen, umfärben, Beschreibung ändern oder neue Eigenschaften hinzufügen. Wird sofort angewendet und an alle verbundenen Benutzer übertragen.

Labels, Beschreibungen oder Eigenschaften vorhandener Beziehungen aktualisieren. Wird sofort angewendet und an alle verbundenen Benutzer übertragen. Beziehungs-IDs akzeptieren sowohl UUIDs als auch Auto-IDs (z. B. „CON-5").

Tags für jedes Modellelement (Knoten, Beziehung, Knotentyp, Beziehungstyp, Diagramm oder Ordner) aktualisieren. Ersetzt alle vorhandenen Tags. Wird sofort angewendet.

Löscht einen einzelnen Basiswert (Überlagerung) für eine Agenten-Eigenschaft in einem Parametersatz (greift wieder auf den Standardsatz zurück). Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht eine einzelne Zeitreihen-Zelle (den Wert einer Agenten-Eigenschaft zu einem Zeitschritt). Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Erstellt eine Agenteninstanz in einem Szenario. node_type_id (der Typ des Agenten) ist erforderlich und legt sein Eigenschafts- und Verhaltensschema fest. Basiswerte von Eigenschaften können über Name oder ID angegeben werden und beziehen sich auf den angegebenen (oder den Standard-) Parametersatz des Twins. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Erstellt eine Verbindung zwischen zwei Agenten in einem Szenario – das Simulations-Gegenstück zu einer Beziehung. Der Beziehungstyp und beide Agenten müssen bereits existieren. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Erstellt einen Parametersatz innerhalb eines Twins – ein benanntes Bündel von Eingabewert-Überschreibungen auf einer zu den Szenarien orthogonalen Achse. Einen stabilen Namen in Kleinbuchstaben verwenden (z. B. „high_demand“). Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Erstellt ein Szenario (Was-wäre-wenn-Projektion) innerhalb eines Twins, mit eigener Zeitachse. Die Schrittweite dt muss 1/N für eine positive ganze Zahl N sein (z. B. 1, 0,5, 0,25). Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Erstellt ein Simulationsdiagramm – eine visuelle Arbeitsfläche für ein Szenario oder einen Twin. Genau eines von scenario_id (szenariobezogen) oder twin_id (twin-übergreifend, über alle Szenarien) angeben. Das Platzieren von Agenten/Verbindungen und Widgets erfolgt in der App. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Erstellt einen Simulations-Twin – einen Live-Twin-Container, der auf eine Teilmenge von Knotentypen beschränkt und optional an einen Modellknoten gebunden ist. Szenarien, Parametersätze und Agenten werden darin angelegt. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht eine Agenteninstanz samt ihren Verbindungen, Zeitreihen und Diagrammplatzierungen. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht eine Verbindung samt ihren Diagrammplatzierungen. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht einen Parametersatz samt seinen Überschreibungswerten und Zeitreihen. Der Standard-Parametersatz eines Twins kann nicht gelöscht werden. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht ein Szenario samt seinen Agenten, Verbindungen und Zeitreihen. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht ein Simulationsdiagramm samt seinen Platzierungen und Widgets. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Löscht einen Twin samt allem, was er enthält – seine Szenarien, Parametersätze, Agenten, Verbindungen und Zeitreihen. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Setzt einen einzelnen Basiswert für eine Agenten-Eigenschaft in einem bestimmten Parametersatz – das Feld, das ein Schieberegler oder ein Kontrollkästchen schreiben würde. Für Werte pro Zeitschritt set_time_series_value verwenden. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Setzt eine einzelne Zelle der Simulationstabelle: den Wert einer Agenten-Eigenschaft zu einem bestimmten Zeitschritt, in einem Szenario und Parametersatz. property_id kann ein Eigenschaftsname oder eine ID sein; parameter_set_id weglassen für den Standard des Twins. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Aktualisiert Bezeichnung, Beschreibung oder die Basiswert-Überlagerung eines Agenten. set_properties ersetzt die gesamte Überlagerung für den Ziel-Parametersatz – um einen einzelnen Wert zu ändern, set_parameter_value verwenden. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Aktualisiert Beschreibung und/oder Eigenschaftswerte einer Verbindung (set_properties ersetzt die Eigenschaften der Verbindung). Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Aktualisiert Name und/oder Beschreibung eines Parametersatzes. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Aktualisiert Name, Beschreibung oder Zeitachse (Startzeit, Endzeit, dt) eines Szenarios. Ein geändertes dt muss weiterhin 1/N für eine positive ganze Zahl N sein. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Aktualisiert Name und/oder Beschreibung eines Simulationsdiagramms. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Aktualisiert Name und/oder Beschreibung eines Twins. Wird sofort angewendet und in Echtzeit an alle verbundenen Nutzer übertragen.

Liefert vollständige Details zu Agenten anhand ihrer ID, einschließlich der Basiswerte der Eigenschaften, gruppiert nach Parametersatz (Eigenschaftsnamen werden aus dem Knotentyp des Agenten aufgelöst).

Liefert die Widgets eines Simulationsdiagramms (Dashboards) mit ihren IDs und ihrem aktuellen Text – Diagramme (Name, Achsenbeschriftungen, Anzeigenamen je Datenreihe) sowie Schieberegler-, Kontrollkästchen-, Auswahl-, Text- und Parametersatz-Auswahl-Steuerelemente (Beschriftung). Diese Widgets existieren nur auf dem Diagramm und erscheinen nicht im Modellbaum, daher ist dies die einzige Möglichkeit, ihre IDs zu ermitteln. Verwenden Sie es, um ein Dashboard zu übersetzen: Inhalte auslesen und anschließend mit translate_elements Übersetzungen schreiben – mit Schlüsseln wie „{chart_id}:name“, „{chart_id}:series:{series_id}:display_name“ und „{widget_id}:label“.

Liest Zeitreihenwerte: den Wert einer Agenten-Eigenschaft zu jedem Zeitschritt, für ein Szenario und einen Parametersatz. Dies sind die Tabellendaten der Simulation. scenario_id ist erforderlich; parameter_set_id weglassen, um über alle Parametersätze hinweg zu lesen.

Listet die Agenteninstanzen eines Szenarios auf. Jeder Agent ist eine Instanz eines Knotentyps und gehört zu genau einem Szenario. Liefert Kurzfassungen; für die Basiswerte der Eigenschaften get_agent_details verwenden. Filterbar nach Szenario, Twin, Knotentyp oder Name.

Listet die Diagramme des Modells mit ihren IDs, Namen und Ebenen auf. Diagramme werden von search_nodes nicht zurückgegeben – über dieses Tool finden Sie die ID eines Diagramms, bevor Sie update_diagram, add_to_diagram, add_relationships_to_diagram, remove_from_diagram oder delete_diagram aufrufen. Filtern Sie nach Ebene (metamodel für Typdiagramme, model für Instanzdiagramme), Namen oder Ordner. Für Simulations-Dashboards verwenden Sie stattdessen list_simulation_diagrams.

Listet die Verbindungen auf – die Verknüpfungen zwischen Agenten innerhalb eines Szenarios (das Simulations-Gegenstück zu Beziehungen). Liefert die Endpunkte mit aufgelösten Agentenbezeichnungen sowie die Eigenschaftswerte der Verbindung. Filterbar nach Szenario, Beziehungstyp oder Endpunkt.

Listet die Parametersätze eines Twins auf. Ein Parametersatz ist ein benanntes Bündel von Eingabewerten auf einer zu den Szenarien orthogonalen Achse – ein Simulationslauf ist durch (Szenario, Parametersatz) bestimmt. Zeigt an, welcher Satz der Standard des Twins ist.

Listet die Szenarien innerhalb von Twins auf. Ein Szenario ist eine Was-wäre-wenn-Projektion mit eigener Zeitachse (Startzeit, Endzeit, Schrittweite dt). Liefert die Zeitachsen-Parameter, die berechnete Anzahl der Zeitschritte sowie die Anzahl der Agenten und Verbindungen. Über twin_id filterbar.

Listet die Simulationsdiagramme auf – die visuellen Arbeitsflächen für ein Szenario oder einen Twin, die Agenten, Verbindungen und Dashboard-Widgets zeigen. Filterbar nach Twin oder Szenario.

Listet die Simulations-Twins auf. Ein Twin ist ein Live-Twin-Container, der auf eine Teilmenge von Knotentypen beschränkt und optional an einen Modellknoten gebunden ist. Liefert für jeden Twin den Geltungsbereich, den Standard-Parametersatz sowie die Anzahl der Szenarien und Parametersätze.