Zum Hauptinhalt wechseln

Anlagenbezogener OData-Service

Verbinden Sie Cognite Data Fusion (CDF) als Datenquelle und verwenden Sie OData-Clients zur Abfrage, Transformation und Visualisierung von Daten, die in anlagenbezogenen CDF-Ressourcen abgelegt sind.

Der anlagenbezogene OData-Service ermöglicht Ihnen über eine OData-API den Zugriff auf CDF-Ressourcen wie assets, time series, events, files, sequences und RAW-Daten.

Der anlagenbezogene OData-Service akzeptiert URLs mit dem folgenden Schema:

https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}

Mit:

  • {cluster}: Name des CDF-Clusters, zum Beispiel westeurope-1.
  • {apiVersion}: Version der OData-Service-API (die neueste Version ist v1).
  • {project}: Name des CDF-Projekts, zum Beispiel publicdata.

Wenn Sie den OData-Client zur richtigen anlagenbezogenen OData-URL führen und authentifizieren, gibt der Server eine Tabelle mit allen anlagenbezogenen Typen zurück, die aktuell neben den unterstützten OData-Funktionen vom OData-Service unterstützt werden.

Anlagenbezogene Ressourcentypen filtern​

Der anlagenbezogene OData-Service kann Filter zu CDF weiterleiten. Dies führt zu einer Leistungsverbesserung, indem sichergestellt wird, dass die Filterung serverseitig erfolgt, wodurch die zum Client übertragene Datenmenge reduziert wird.

Filteroptionen​

  • Weiterleitung: Filterfunktionen, die zum CDF-Backend weitergeleitet werden. Dies ist die effizienteste Filterung.
  • Lokal: Filtermethode, die vom OData-Service durchgeführt wird, bevor das Ergebnis an den Client zurückgegeben wird. Weniger effizient als die Weiterleitung.
  • Clientseitig: Die Filterung wird nach dem Abruf der Daten vom Client durchgeführt. Die am wenigsten effiziente Filtermethode.

Definitionen​

  • FilterFunctions: Contains, StartsWith und EndsWith.
  • Comparison: <, <=, >, >= und =.
  • Search: Verwendet die Such-API und kann zusätzliches lokales Filtern erfordern.
Info

Die Suche gibt eine beschränkte Anzahl von Zeilen zurück. Sie erhalten vielleicht nicht alle passenden Daten in CDF.

Assets (Anlagenteile)​

EigenschaftWeiterleitungLokal
Id==
ExternalId=, StartsWith=, FilterFunctions
Name=, Search=, FilterFunctions
DescriptionSearch=, FilterFunctions
ParentId==
ParentExternalId==
DataSetId==
Source==
MetaData=
RootId==
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison

Time series (Zeitreihe)​

EigenschaftWeiterleitungLokal
Id==
ExternalId=, StartsWith=, FilterFunctions
Name=, Search=, FilterFunctions
DescriptionSearch=, FilterFunctions
IsString==
MetaData=
Unit==
IsStep==
AssetId==
SecurityCategories
DataSetId==
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison

Data point (Datenpunkt)​

EigenschaftWeiterleitungLokal
Id==
TimeStampComparisonComparison

Events (Ereignisse)​

EigenschaftWeiterleitungLokal
Id==
ExternalId=, StartsWithFilterFunctions
DescriptionSearch=, FilterFunctions
Source==
Type==
SubType==
MetaData=
DataSetId==
StartTimeComparisonComparison
EndTimeComparisonComparison
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison
AssetIdsContainsContains

Files (Dateien)​

EigenschaftWeiterleitungLokal
Id==
ExternalId=, StartsWith=, FilterFunctions
Name=, Search=, FilterFunctions
Source==
MimeType==
MetaData
DataSetId==
SourceCreatedTimeComparisonComparison
SourceModifiedTimeComparisonComparison
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison
UploadedTimeComparisonComparison
Uploaded==
AssetIdsContainsContains

Sequences (Sequenzen)​

EigenschaftWeiterleitungLokal
Id*=
ExternalIdStartsWith=, StartsWith
Name=, Search=, FilterFunctions
Description=, Search=, FilterFunctions
MetaData
AssetId==
DataSetId==
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison
Columns
Hinweis

Unterstützt über die Sequences(id)-Syntax.

CDF RAW-Datenbanken​

EigenschaftWeiterleitungLokal
Name==

CDF RAW-Tabellen​

EigenschaftWeiterleitungLokal
Name==

CDF RAW-Zeilen​

EigenschaftWeiterleitungLokal
Key==, FilterFunction
LastUpdatedTimeComparisonComparison

Unterstützte OData-Funktionen​

AssetsRoots​

Abruf der Hauptanlagenteile für ein CDF-Projekt.

ParameterTypBeschreibung
Keine Parameter

AssetsSearch​

Suche nach Anlagenteilen in einem CDF-Projekt.

ParameterTypBeschreibung
SearchTextDurch Leerzeichen getrennte Begriffe für die Suche nach Anlagenteilen. Führt in den relevanten Feldern (derzeit name und description) bestmöglich eine ungenaue Suche nach Suchbegriffvariationen durch. Die Ergebnisse werden nach Relevanz sortiert.

EventsSearch​

Suche nach Ereignissen in einem CDF-Projekt.

ParameterTypBeschreibung
SearchTextDurch Leerzeichen getrennte Begriffe für die Suche nach Ereignissen. Führt in den relevanten Feldern (derzeit description) bestmöglich eine ungenaue Suche nach Suchbegriffvariationen durch. Die Ergebnisse werden nach Relevanz sortiert.

TimeseriesAggregate​

Aggregation von Datenpunkten aus multiplen Zeitreihen.

ParameterTypBeschreibung
TagsTextDurch Komma getrennte Liste von Zeitreihen-IDs oder externen IDs für die Abfrage.
GranularityTextDie Granularität für den Abruf von Datenpunktaggregaten.
StartTextDatenpunkte werden ab diesem Zeitpunkt abgerufen, wobei der genannte Zeitpunkt eingeschlossen ist.
EndText (optional)Datenpunkte werden bis zu diesem Zeitpunkt abgerufen, wobei der genannte Zeitpunkt nicht mit eingeschlossen ist. Wenn kein Wert festgelegt wird, gilt der aktuelle Zeitpunkt als Standardvorgabe.

TimeseriesSearch​

Zeitreihensuche in einem CDF-Projekt.

ParameterTypBeschreibung
SearchTextDurch Leerzeichen getrennte Begriffe für die Suche in Zeitreihen. Führt in den relevanten Feldern (derzeit name und description) bestmöglich eine ungenaue Suche nach Suchbegriffvariationen durch und sortiert die Ergebnisse nach Relevanz.
Zuletzt aktualisiert