Asset-centric OData サービス
Cognite Data Fusion (CDF) をデータ ソースとして接続し、OData クライアントを使用して CDF のアセット中心リソースに保存されたデータをクエリ、変換、および可視化します。
asset-centric OData サービスを使用すると、OData API を介して assets、time series、events、files、sequences、および RAW データなどの CDF リソースにアクセスできます。
asset-centric OData サービスは、以下のスキーマを持つ URL を受け入れます。
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
ここで
{cluster}
:CDFクラスターの名前、例:westeurope-1
。{apiVersion}
:ODataサービス API のバージョン(最新はv1
)。{project}
:CDFプロジェクトの名前、例:publicdata
。
OData クライアントを正しい asset-centric OData URL に向けて認証すると、サーバーは OData サービスで現在サポートされているすべての asset-centric タイプとサポートされている OData 関数](#supported-odata-functions)を含むテーブルを返します。
asset-centric リソース タイプのフィルタリング
asset-centric OData サービスは、フィルターを CDF にプッシュすることができます。これにより、フィルタリングがサーバー側で行われ、クライアントに送信されるデータ量が削減されるため、パフォーマンスが向上します。
フィルタリング オプション
- プッシュダウン:
CDFバックエンドにプッシュされるフィルター関数。これが最も効率的なフィルタリングです。 - ローカル:クライアントに結果を返す前に、
ODataサービスによってフィルタリングが実行されます。プッシュダウンよりも効率が劣ります。 - クライアント側:データが取得された後にクライアントによって行われるフィルタリングです。最も効率が劣ります。
定義
- FilterFunctions:
Contains
、StartsWith
、およびEndsWith
。 - Comparison:
<
、<=
、>
、>=
、および=
。 - 検索: 検索 API を使用し、追加のローカル フィルタリングが必要になる場合があります。
情報
検索で返される行の数には限りがあり、一致するすべてのデータを CDF で受け取れるとは限りません。
Assets (アセット)
プロパティ | プッシュダウン | ローカル |
---|---|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Search | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Time series (時系列)
プロパティ | プッシュダウン | ローカル |
---|---|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Search | =, FilterFunctions |
IsString | = | = |
MetaData | = | |
Unit | = | = |
IsStep | = | = |
AssetId | = | = |
SecurityCategories | ||
DataSetId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Data point (データポイント)
プロパティ | プッシュダウン | ローカル |
---|---|---|
Id | = | = |
TimeStamp | Comparison | Comparison |
Events (イベント)
プロパティ | プッシュダウン | ローカル |
---|---|---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Search | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Comparison | Comparison |
EndTime | Comparison | Comparison |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
AssetIds | Contains | Contains |
Files (ファイル)
プロパティ | プッシュダウン | ローカル |
---|---|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Source | = | = |
MimeType | = | = |
MetaData | ||
DataSetId | = | = |
SourceCreatedTime | Comparison | Comparison |
SourceModifiedTime | Comparison | Comparison |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
UploadedTime | Comparison | Comparison |
Uploaded | = | = |
AssetIds | Contains | Contains |
Sequences (シーケンス)
プロパティ | プッシュダウン | ローカル |
---|---|---|
Id | * | = |
ExternalId | StartsWith | =, StartsWith |
Name | =, Search | =, FilterFunctions |
Description | =, Search | =, FilterFunctions |
MetaData | ||
AssetId | = | = |
DataSetId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Columns |
注意
Sequences(id)
構文を通じてサポートされています。
CDF RAW データベース
プロパティ | プッシュダウン | ローカル |
---|---|---|
Name | = | = |
CDF RAW テーブル
プロパティ | プッシュダウン | ローカル |
---|---|---|
Name | = | = |
CDF RAW 行
プロパティ | プッシュダウン | ローカル |
---|---|---|
Key | = | =, FilterFunction |
LastUpdatedTime | Comparison | Comparison |
サポートされている OData 関数
AssetsRoots
CDF プロジェクトのルートアセットを取得します。
パラメータ | タイプ | 説明 |
---|---|---|
パラメータなし |
AssetsSearch
CDF プロジェクト内のアセットを検索します。
パラメータ | タイプ | 説明 |
---|---|---|
Search | テキスト | アセット内で検索する空白で区切られた語句。現在のところ name および description で、あらゆる検索語句のバリエーションについて、関連フィールド内でベストエフォートによるファジー検索を行います。結果は関連性に基づいて並べ替えられます。 |
EventsSearch
CDF プロジェクト内のイベントを検索します。
パラメータ | タイプ | 説明 |
---|---|---|
Search | テキスト | イベント内で検索する空白で区切られた語句。現在のところ description で、あらゆる検索語句のバリエーションについて、関連フィールド内でベストエフォートによるファジー検索を行います。結果は関連性に基づいて並べ替えられます。 |
TimeseriesAggregate
複数の時系列からデータ ポイントを集計します。
パラメータ | タイプ | 説明 |
---|---|---|
Tags | テキスト | クエリに含める時系列 ID または外部 ID のカンマ区切りのリスト。 |
Granularity | テキスト | データ ポイントの集計を取得する際に使用される粒度。 |
Start | テキスト | この時間から始まり、この時間を含むデータ ポイントを取得します。 |
End | テキスト(オプション) | この時点までのデータ ポイントを取得しますが、この時点は含みません。値を指定しない場合、デフォルトで現在の時刻になります。 |
TimeseriesSearch
CDF プロジェクト内の時系列を検索します。
パラメータ | タイプ | 説明 |
---|---|---|
Search | テキスト | 時系列内で検索する空白で区切られた語句。現在のところ name および description で、あらゆる検索語句のバリエーションについて、関連フィールド内でベストエフォートによるファジー検索を行い、結果を関連性に基づいて並べ替えます。 |