Asset-centric OData 服务
连接 Cognite Data Fusion (CDF) 作为数据源,并使用 OData 客户端查询、转换和显示存储在 CDF asset-centric 资源中的数据。
Asset-centric OData 服务可让你通过 OData API 访问 CDF 资源,例如 assets、time series、events、files、sequences 和 RAW 数据。
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服务完成的筛选。效率比下推低。 - 客户端:在检索数据后由客户端完成的筛选。效率最低。
定义
- 筛选函数:
Contains
、StartsWith
和EndsWith
。 - 对比:
<
、<=
、>
、>=
和=
。 - 搜索:使用搜索 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 | 对比 | 对比 |
AssetIds | Contains | Contains |
Files(文件)
属性 | 下推 | 本地 |
---|---|---|
Id | = | = |
ExternalId | =、StartsWith | =、筛选函数 |
Name | =、搜索 | =、筛选函数 |
Source | = | = |
MimeType | = | = |
MetaData | ||
DataSetId | = | = |
SourceCreatedTime | 对比 | 对比 |
SourceModifiedTime | 对比 | 对比 |
CreatedTime | 对比 | 对比 |
LastUpdatedTime | 对比 | 对比 |
UploadedTime | 对比 | 对比 |
Uploaded | = | = |
AssetIds | Contains | Contains |
Sequences(序列)
属性 | 下推 | 本地 |
---|---|---|
Id | * | = |
ExternalId | StartsWith | =、StartsWith |
Name | =、搜索 | =、筛选函数 |
Description | =、搜索 | =、筛选函数 |
MetaData | ||
AssetId | = | = |
DataSetId | = | = |
CreatedTime | 对比 | 对比 |
LastUpdatedTime | 对比 | 对比 |
Columns |
注意
通过 Sequences(id)
语法提供支持。
CDF RAW 数据库
属性 | 下推 | 本地 |
---|---|---|
Name | = | = |
CDF RAW 表格
属性 | 下推 | 本地 |
---|---|---|
Name | = | = |
CDF RAW 行
属性 | 下推 | 本地 |
---|---|---|
Key | = | =、筛选函数 |
LastUpdatedTime | 对比 | 对比 |
支持的 OData 函数
AssetsRoots
获取 CDF 项目的根资产。
参数 | Type | Description |
---|---|---|
无参数 |
AssetsSearch
在 CDF 项目中搜索资产。
参数 | Type | Description |
---|---|---|
Search | 文本 | 在资产中搜索的以空格分隔的词语。在相关字段(当前为 name 和 description )中尽力模糊搜索任何搜索词的变体。按相关性对结果进行排序。 |
EventsSearch
在 CDF 项目中搜索事件。
参数 | Type | Description |
---|---|---|
Search | 文本 | 在事件中搜索的以空格分隔的词语。在相关字段(当前为 description )中尽力模糊搜索任何搜索词的变体。按相关性对结果进行排序。 |
TimeseriesAggregate
聚合来自多个时间序列的数据点。
参数 | Type | Description |
---|---|---|
Tags | 文本 | 要包含在查询中的以逗号分隔的时间序列 ID 或外部 ID 列表。 |
Granularity | 文本 | 用于获取数据点聚合的粒度。 |
Start | 文本 | 获取从该时间开始(且包括该时间)的数据点。 |
End | 文本(可选) | 获取截至该时间(但不包括该时间)的数据点。如果没有提供值,则默认为现在。 |
TimeseriesSearch
在 CDF 项目中搜索时间序列。
参数 | Type | Description |
---|---|---|
Search | 文本 | 在时间序列中搜索的以空格分隔的词语。在相关字段(当前为 name 和 description )中尽力模糊搜索任何搜索词的变体,并按相关性对结果进行排序。 |