Serviço do OData centrado em ativos

Conecte o Cognite Data Fusion (CDF) como uma fonte de dados e use o OData para consultar, transformar e visualizar os dados armazenados em recursos centrados em ativos do CDF.

O serviço centrado em ativos do OData permite acessar recursos do CDF como dados de assets, time series, events, files, sequences e RAW por meio de uma API do OData.

O serviço do OData centrado em ativos aceita URLs com o seguinte esquema:

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

Onde:

• {cluster}: é o nome do cluster do CDF (por exemplo westeurope-1).
• {apiVersion}: é a versão da API do serviço do OData (a mais recente é v1).
• {project}: é o nome do projeto do CDF (por exemplo publicdata).

Se você apontar o cliente do OData para a URL correta do OData centrado em ativos e se autentificar, o servidor retorna uma tabela com todos os tipos centrados em ativos atualmente compatíveis como o serviço do OData, além das funções do OData compatíveis.

Filtragem de tipos de recursos centrados em ativos

O serviço do OData centrado em ativos pode enviar filtros para o CDF. Isso melhora o desempenho garantindo que a filtragem aconteça no lado do servidor, reduzindo a quantidade de dados transmitidos para o cliente.

Opções de filtragem

• Pushdown: Funções de filtro que são enviadas para o servidor do CDF. Esta é a filtragem mais eficiente.
• Local: Filtragem feita pelo serviço do OData antes de retornar o resultado para o cliente. Menos eficiente que o pushdown.
• Lado do cliente: Filtragem realizada pelo cliente após a recuperação dos dados. Menos eficiente.

Definições

• FilterFunctions: Contains, StartsWith e EndsWith.
• Comparison: <, <=, >, >= e =.
• Search: usa a API de pesquisa e pode exigir filtragem local adicional.

informações

A pesquisa retorna um número limitado de linhas e talvez você não receba todos os dados correspondentes no CDF.

Assets (ativos)

Propriedade	Pushdown	Local
Id	=	=
ExternalId	=, StartsWith	=, FilterFunctions
Name	=, Search	=, FilterFunctions
Description	Pesquisar	=, FilterFunctions
ParentId	=	=
ParentExternalId	=	=
DataSetId	=	=
Source	=	=
MetaData	=
RootId	=	=
CreatedTime	Comparison	Comparison
LastUpdatedTime	Comparison	Comparison

Time series (série temporal)

Propriedade	Pushdown	Local
Id	=	=
ExternalId	=, StartsWith	=, FilterFunctions
Name	=, Search	=, FilterFunctions
Description	Pesquisar	=, FilterFunctions
IsString	=	=
MetaData	=
Unit	=	=
IsStep	=	=
AssetId	=	=
SecurityCategories
DataSetId	=	=
CreatedTime	Comparison	Comparison
LastUpdatedTime	Comparison	Comparison

Data point (ponto de dados)

Propriedade	Pushdown	Local
Id	=	=
TimeStamp	Comparison	Comparison

Events (eventos)

Propriedade	Pushdown	Local
Id	=	=
ExternalId	=, StartsWith	FilterFunctions
Description	Pesquisar	=, FilterFunctions
Source	=	=
Type	=	=
SubType	=	=
MetaData	=
DataSetId	=	=
StartTime	Comparison	Comparison
EndTime	Comparison	Comparison
CreatedTime	Comparison	Comparison
LastUpdatedTime	Comparison	Comparison
AssetIds	Contains	Contains

Files (arquivos)

Propriedade	Pushdown	Local
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 (sequências)

Propriedade	Pushdown	Local
Id	*	=
ExternalId	StartsWith	=, StartsWith
Name	=, Search	=, FilterFunctions
Description	=, Search	=, FilterFunctions
MetaData
AssetId	=	=
DataSetId	=	=
CreatedTime	Comparison	Comparison
LastUpdatedTime	Comparison	Comparison
Columns

observação

Compatível por meio da sintaxe Sequences(id).

Bancos de dados do CDF RAW

Propriedade	Pushdown	Local
Name	=	=

Tabelas do CDF RAW

Propriedade	Pushdown	Local
Name	=	=

Linhas do CDF RAW

Propriedade	Pushdown	Local
Key	=	=, FilterFunction
LastUpdatedTime	Comparison	Comparison

Funções compatíveis do OData

AssetsRoots

Busque os ativos raiz para um projeto do CDF.

Parâmetro	Tipo	Descrição
Sem parâmetros

AssetsSearch

Pesquisar ativos em um projeto do CDF.

Parâmetro	Tipo	Descrição
Search	Texto	Termos separados por espaços em branco para pesquisar em ativos. Faz uma pesquisa aproximada e otimizada em campos relevantes (atualmente name e description) para variações de qualquer termo de pesquisa. Ordena os resultados por relevância.

EventsSearch

Pesquise eventos em um projeto do CDF.

Parâmetro	Tipo	Descrição
Search	Texto	Termos separados por espaços em branco para pesquisar em eventos. Faz uma pesquisa aproximada e otimizada em campos relevantes (atualmente description) para variações de qualquer termo de pesquisa. Ordena os resultados por relevância.

TimeseriesAggregate

Agregue pontos de dados de várias séries temporais.

Parâmetro	Tipo	Descrição
Tags	Texto	Uma lista separada por vírgulas de IDs de séries temporais ou IDs externas a serem incluídas na consulta.
Granularity	Texto	A granularidade utilizada para buscar agregados de pontos de dados.
Start	Texto	Obtenha os pontos de dados a partir de e incluindo este momento.
End	Texto (opcional)	Obtenha pontos de dados até, mas excluindo, este momento no tempo. Se nenhum valor for fornecido, o padrão será o momento atual.

TimeseriesSearch

Pesquisar série temporal em um projeto do CDF.

Parâmetro	Tipo	Descrição
Search	Texto	Termos separados por espaços para pesquisar em séries temporais. Realiza uma pesquisa aproximada de melhor esforço nos campos relevantes (atualmente name e description) para variações de quaisquer termos de pesquisa e classifica os resultados por relevância.