跳至主要内容

Asset-centric OData 服务

连接 Cognite Data Fusion (CDF) 作为数据源,并使用 OData 客户端查询、转换和显示存储在 CDF asset-centric 资源中的数据。

Asset-centric OData 服务可让你通过 OData API 访问 CDF 资源,例如 assetstime serieseventsfilessequencesRAW 数据。

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 函数 外,还包含 OData 服务当前支持的所有 asset-centric 类型。​

筛选 asset-centric 资源类型

Asset-centric OData 服务可将筛选器下推到 CDF。这样可以确保在服务器端进行筛选,减少传输到客户端的数据量,从而提高性能。

筛选选项

  • 下推:下推到 CDF 后端的筛选函数。这是最有效的筛选方式。
  • 本地:在将结果返回到客户端之前由 OData 服务完成的筛选。效率比下推低。
  • 客户端:在检索数据后由客户端完成的筛选。效率最低。

定义

  • 筛选函数ContainsStartsWithEndsWith
  • 对比<<=>>==
  • 搜索:使用搜索 API,可能需要额外的本地筛选。
信息

搜索返回有限数量的行,你可能未在 CDF 收到所有匹配的数据。

Assets(资产)

属性下推本地
Id==
ExternalId=、StartsWith=、筛选函数
Name=、搜索=、筛选函数
Description搜索=、筛选函数
ParentId==
ParentExternalId==
DataSetId==
Source==
MetaData=
RootId==
CreatedTime对比对比
LastUpdatedTime对比对比

Time series(时间序列)

属性下推本地
Id==
ExternalId=、StartsWith=、筛选函数
Name=、搜索=、筛选函数
Description搜索=、筛选函数
IsString==
MetaData=
Unit==
IsStep==
AssetId==
SecurityCategories
DataSetId==
CreatedTime对比对比
LastUpdatedTime对比对比

Data point (数据点)

属性下推本地
Id==
TimeStamp对比对比

Events(事件)

属性下推本地
Id==
ExternalId=、StartsWith筛选函数
Description搜索=、筛选函数
Source==
Type==
SubType==
MetaData=
DataSetId==
StartTime对比对比
EndTime对比对比
CreatedTime对比对比
LastUpdatedTime对比对比
AssetIdsContainsContains

Files(文件)

属性下推本地
Id==
ExternalId=、StartsWith=、筛选函数
Name=、搜索=、筛选函数
Source==
MimeType==
MetaData
DataSetId==
SourceCreatedTime对比对比
SourceModifiedTime对比对比
CreatedTime对比对比
LastUpdatedTime对比对比
UploadedTime对比对比
Uploaded==
AssetIdsContainsContains

Sequences(序列)

属性下推本地
Id*=
ExternalIdStartsWith=、StartsWith
Name=、搜索=、筛选函数
Description=、搜索=、筛选函数
MetaData
AssetId==
DataSetId==
CreatedTime对比对比
LastUpdatedTime对比对比
Columns
注意

通过 Sequences(id) 语法提供支持。

CDF RAW 数据库

属性下推本地
Name==

CDF RAW 表格

属性下推本地
Name==

CDF RAW

属性下推本地
Key==、筛选函数
LastUpdatedTime对比对比

支持的 OData 函数

AssetsRoots

获取 CDF 项目的根资产。

参数TypeDescription
无参数

AssetsSearch

CDF 项目中搜索资产。

参数TypeDescription
Search文本在资产中搜索的以空格分隔的词语。在相关字段(当前为 namedescription)中尽力模糊搜索任何搜索词的变体。按相关性对结果进行排序。

EventsSearch

CDF 项目中搜索事件。

参数TypeDescription
Search文本在事件中搜索的以空格分隔的词语。在相关字段(当前为 description)中尽力模糊搜索任何搜索词的变体。按相关性对结果进行排序。

TimeseriesAggregate

聚合来自多个时间序列的数据点。

参数TypeDescription
Tags文本要包含在查询中的以逗号分隔的时间序列 ID 或外部 ID 列表。
Granularity文本用于获取数据点聚合的粒度。
Start文本获取从该时间开始(且包括该时间)的数据点。
End文本(可选)获取截至该时间(但不包括该时间)的数据点。如果没有提供值,则默认为现在。

TimeseriesSearch

CDF 项目中搜索时间序列。

参数TypeDescription
Search文本在时间序列中搜索的以空格分隔的词语。在相关字段(当前为 namedescription)中尽力模糊搜索任何搜索词的变体,并按相关性对结果进行排序。