Abrufen
API-Ansätze
All information regarding access to data
Alle Tags anzeigenAPI-Ansätze
Aggregationsabfragen berechnen Zusammenfassungswerte (Durchschnitte, Summen, Extremwerte) über Zeitreihen-Datenpunkte hinweg, anstatt einzelne Zeilen zurückzugeben. Verwenden Sie diese, wenn Sie berechnete Kennzahlen statt Rohdaten benötigen – zum Beispiel die durchschnittliche Spannung über die letzte Stunde oder die insgesamt pro Maschine erzeugte Energie.
GraphQL erlaubt es, Daten abzufragen und zu verändern. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten aktualisiert werden können.
Association Roles definieren die Beziehungstypen zwischen Entitäten. Jede Role legt die Multiplizität und Benennung für beide Richtungen der Beziehung fest (inbound und outbound).
Assoziationen definieren Beziehungen zwischen Entitäten im Runtime-Modell. Dieses Kapitel beschreibt, wie Sie Assoziationen abfragen und navigieren.
Attribute sind wiederverwendbare Property-Definitionen, die auf Typen angewendet werden können. Jedes Attribut besitzt einen Wertetyp und optionale Einschränkungen.
Ein Access-Token holen und Runtime-Entities, Assoziationen und Stream Data über die GraphQL-API von OctoMesh abfragen, mit curl und Python.
Dieses Kapitel enthält Best Practices für das Schreiben effizienter und wartbarer GraphQL-Queries und -Mutationen.
Modelle mit ckLanguage 1).
Der Construction Kit definiert das Schema und die Struktur Ihres Datenmodells. Anders als das Runtime-Modell, das die tatsächlichen Dateninstanzen speichert, enthält der Construction Kit die Metadaten, die festlegen, welche Arten von Entitäten existieren können, sowie deren Attribute, Beziehungen und Einschränkungen.
GraphQL ermöglicht das Abfragen und Mutieren von Daten. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten erstellt werden können.
GraphQL ermöglicht das Abfragen und Mutieren von Daten. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten gelöscht werden können.
Eine Downsampling-Abfrage reduziert die Dichte von Zeitreihendaten, indem sie einen Zeitbereich in gleich große Buckets unterteilt und auf jeden Bucket eine Aggregationsfunktion anwendet. Dies ist für die Visualisierung großer Datensätze auf Dashboards und in Diagrammen unverzichtbar – anstatt Tausende von Rohdatenpunkten zu übertragen, erhalten Sie eine handhabbare Anzahl zusammengefasster Werte.
Enums definieren eine feste Menge erlaubter Werte für ein Attribut. Jeder Enum-Wert hat einen numerischen Schlüssel, einen Namen und eine optionale Beschreibung.
Dieses Kapitel beschreibt, wie Fehler in GraphQL-Antworten zurückgegeben werden und wie sie behandelt werden.
Diese Seite ist die architektonische Grundlage für Streamdaten: das mentale Modell und das Vokabular, das Sie benötigen, bevor Sie entweder die vollständige Referenz Stream Data Archives oder das Deep-Dive Rollups & recompute lesen. Sie erklärt, wie die Teile zusammenpassen – die Aufteilung auf zwei Stores, die drei Archivtypen, wie Zeilen gespeichert werden, wie ein Archiv seinen Lebenszyklus durchläuft und was auf dem Schreib- und Lesepfad geschieht – und übergibt dann an die Referenz- und Deep-Dive-Seiten für die erschöpfenden Details.
Modelle sind Container, die zusammengehörige Types, Attribute, Enums und Records gruppieren. Jedes Modell hat einen Namen, eine Version und kann von anderen Modellen abhängen.
Persistierte Abfragen sind gespeicherte Abfragedefinitionen, die als Runtime-Entitäten abgelegt werden. Anstatt jedes Mal alle Abfrageparameter anzugeben, erstellen Sie eine Abfragedefinition einmal und führen sie über ihre rtId aus. Das ist nützlich für Dashboard-Widgets, wiederkehrende Berichte und jedes Szenario, in dem dieselbe Abfrage wiederholt ausgeführt werden muss.
Records sind zusammengesetzte Wertetypen, die verwandte Attribute zusammenfassen. Anders als Typen werden Records direkt in Entitäten eingebettet, statt eigenständige Entitäten mit eigenen Runtime-IDs zu sein.
Dieses Kapitel beschreibt gängige Query-Muster zum Abrufen von Construction-Kit-Metadaten. Die Construction-Kit-API ist ausschließlich lesend – Sie fragen die Modellstruktur ab, können sie aber nicht über GraphQL verändern.
Diese Seite ist der an Ingenieure gerichtete Begleiter zu Stream Data Archives. Sie erklärt, wie ein RollupArchive seine abgeleiteten Aggregationen korrekt hält, während sich die zugrunde liegenden Daten ändern – das Erkennungskriterium, das Dirty-Windows-Ledger, der Abhängigkeitsgraph, der periodische Orchestrator und der optimistische atomare Swap, der Leser durchgehend auf einem konsistenten Snapshot hält.
GraphQL ermöglicht das Abfragen und Mutieren von Daten. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten erstellt, abgerufen, aktualisiert und gelöscht werden können. Es bietet eine Referenz für die GraphQL-Scalar-Typen, Input-Typen und Enums, die in der OctoMesh-GraphQL-API verwendet werden.
Der SearchFilter bietet Textsuchfunktionen über mehrere Attribute einer Entität hinweg. Er ist für textbasierte Suchen optimiert und wird typischerweise für Suchfelder in Listenansichten verwendet.
Diese Seite beschreibt, wie die GraphQL-API des Asset Repository, die REST-API der Identity Provider, MCP und octo-cli Attribute vom Werttyp Secret behandeln. Die Regel in einem Satz: Sie können ein Secret schreiben und sehen, ob es gesetzt ist — keine API gibt den Wert zurück.
Eine Simple Query ruft rohe Zeitreihenzeilen aus CrateDB ab. Sie wählen aus, welche Spalten zurückgegeben werden, und können Filter, Sortierung und Zeitraumeinschränkungen anwenden. Dies ist der grundlegendste Streamdaten-Abfragetyp – verwenden Sie ihn, wenn Sie einzelne Datenpunkte statt aggregierter Zusammenfassungen benötigen.
Ein Stream Data Archive ist die Einheit für Konfiguration und Speicherung von Zeitreihendaten in OctoMesh. Jedes Archiv ist eine versionierte, typisierte CrateDB-Tabelle pro Tenant, die eine kuratierte Menge von Attributpfaden eines Construction-Kit-Typs erfasst. Archive haben einen strengen Lebenszyklus (Created → Activated → Disabled / Failed), ein nach der Aktivierung unveränderliches Schema und ein dreistufiges Aktivierungs-Gate (Instanz → Tenant → Archiv), das bestimmt, ob die Datenebene geöffnet ist.
Dieses Kapitel beschreibt, wie System Queries erstellt werden. Einen Überblick über System Queries und ihre Anwendungsfälle finden Sie unter System Queries.
Dieses Kapitel beschreibt, wie System Queries aktualisiert werden. Einen Überblick über System Queries und ihre Anwendungsfälle finden Sie unter System Queries.
Systemabfragen sind wiederverwendbare Abfragekonfigurationen, die im Repository gespeichert werden. Sie erlauben es Ihnen, eine Abfrage einmal zu definieren und sie von mehreren Stellen aus nur über ihre ID auszuführen.
Streamdaten werden immer in UTC gespeichert. Viele Fragen werden jedoch in ziviler (Wanduhr-)Zeit für einen bestimmten Ort gestellt: „Wie waren die Werte **gestern**? diese Woche? letzten Monat?" – gemeint sind die lokalen Tages-/Wochen-/Monatsgrenzen einer gewählten Zeitzone, nicht ein UTC-Tag, der gegen den lokalen verschoben ist.
Transiente Abfragen erlauben es Ihnen, Runtime-Entitäten dynamisch mit konfigurierbaren Spaltenpfaden abzufragen. Anders als bei regulären Abfragen, bei denen die zurückgegebenen Felder in der GraphQL-Abfrage selbst definiert werden, geben transiente Abfragen Daten in einer tabellenartigen Struktur mit Zeilen und Zellen zurück.
Types definieren die Struktur von Entitäten im Runtime-Modell. Jeder Typ besitzt Attribute, kann von einem Basistyp erben und kann an Assoziationen mit anderen Typen teilnehmen.
Bei OctoMesh verstehen wir, dass Daten das Herzstück Ihres Betriebs sind. Dieses Kapitel behandelt, wie Sie über unsere Construction Kits (CK) auf Ihre Daten zugreifen und mit ihnen interagieren können – zugeschnitten sowohl auf Runtime-Daten als auch auf Streamdaten (Zeitreihen). Durch die Nutzung von GraphQL-Endpunkten bietet OctoMesh eine nahtlose und effiziente Möglichkeit, mit Ihren Daten zu arbeiten, unabhängig von deren Beschaffenheit.
Streamdaten bieten Zugriff auf Zeitreihendaten, die in CrateDB gespeichert sind. Während Runtime-Abfragen den aktuellen Zustand von Entitäten aus MongoDB abrufen, rufen Streamdaten-Abfragen historische Messwerte und Ereignisse ab, die über die Zeit aufgezeichnet wurden – etwa Sensormesswerte, Maschinenkennzahlen oder Werte der Energieerzeugung.