Servicio OData centrado en activos

Conecte Cognite Data Fusion (CDF) como una fuente de datos y use clientes OData para consultar, transformar y visualizar datos almacenados en recursos centrados en activos de CDF.

El servicio OData centrado en activos le permite acceder a recursos CDF, como datos assets, time series, events, files, sequences y RAW, a través de una API OData.

El servicio OData centrado en activos acepta URL con el siguiente esquema:

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

Donde:

• {cluster}: es el nombre del clúster de CDF, por ejemplo, westeurope-1.
• {apiVersion}: la versión de la API del servicio OData (la más reciente es v1).
• {project}: el nombre del proyecto CDF, por ejemplo, publicdata.

Si apunta el cliente OData a la URL centrada en activos OData correcta y se autentica, el servidor devolverá una tabla con todos los tipos centrados en activos que actualmente admite el servicio OData, además de las funciones OData compatibles.

Filtrado de tipos de recursos centrados en activos

El servicio OData centrado en activos puede enviar filtros a CDF. Esto mejora el rendimiento al garantizar que el filtrado se realice en el lado del servidor, lo que reduce la cantidad de datos transmitidos al cliente.

Opciones de filtrado

• Delegado: Funciones de filtro que se envían al backend CDF. Este es el filtrado más eficiente.
• Local: Filtrado realizado por el servicio OData antes de devolver el resultado al cliente. Menos eficiente que el filtrado delegado.
• Lado del cliente: Filtrado realizado por el cliente después de recuperar los datos. Es el menos eficiente.

Definiciones

• FilterFunctions: Contains, StartsWith y EndsWith.
• Comparación: <, <=, >, >= y =.
• Búsqueda: usa la API de búsqueda y puede requerir filtrado local adicional.

información

La búsqueda devuelve un número limitado de filas y es posible que no reciba todos los datos coincidentes en CDF.

Assets (Activos)

Propiedad	Delegación	Local
Id	=	=
ExternalId	=, StartsWith	=, FilterFunctions
Name	=, Buscar	=, FilterFunctions
Description	Buscar	=, FilterFunctions
ParentId	=	=
ParentExternalId	=	=
DataSetId	=	=
Source	=	=
MetaData	=
RootId	=	=
CreatedTime	Comparación	Comparación
LastUpdatedTime	Comparación	Comparación

Time series (Serie cronológica)

Propiedad	Delegación	Local
Id	=	=
ExternalId	=, StartsWith	=, FilterFunctions
Name	=, Buscar	=, FilterFunctions
Description	Buscar	=, FilterFunctions
IsString	=	=
MetaData	=
Unit	=	=
IsStep	=	=
AssetId	=	=
SecurityCategories
DataSetId	=	=
CreatedTime	Comparación	Comparación
LastUpdatedTime	Comparación	Comparación

Data point (Punto de datos)

Propiedad	Delegación	Local
Id	=	=
TimeStamp	Comparación	Comparación

Events (Eventos)

Propiedad	Delegación	Local
Id	=	=
ExternalId	=, StartsWith	FilterFunctions
Description	Buscar	=, FilterFunctions
Source	=	=
Type	=	=
SubType	=	=
MetaData	=
DataSetId	=	=
StartTime	Comparación	Comparación
EndTime	Comparación	Comparación
CreatedTime	Comparación	Comparación
LastUpdatedTime	Comparación	Comparación
AssetIds	Contains	Contains

Files (Archivos)

Propiedad	Delegación	Local
Id	=	=
ExternalId	=, StartsWith	=, FilterFunctions
Name	=, Buscar	=, FilterFunctions
Source	=	=
MimeType	=	=
MetaData
DataSetId	=	=
SourceCreatedTime	Comparación	Comparación
SourceModifiedTime	Comparación	Comparación
CreatedTime	Comparación	Comparación
LastUpdatedTime	Comparación	Comparación
UploadedTime	Comparación	Comparación
Uploaded	=	=
AssetIds	Contains	Contains

Sequences (Secuencias)

Propiedad	Delegación	Local
Id	*	=
ExternalId	StartsWith	=, StartsWith
Name	=, Buscar	=, FilterFunctions
Description	=, Buscar	=, FilterFunctions
MetaData
AssetId	=	=
DataSetId	=	=
CreatedTime	Comparación	Comparación
LastUpdatedTime	Comparación	Comparación
Columns

nota

Se admite con la sintaxis Sequences(id).

bases de datos CDF RAW

Propiedad	Delegación	Local
Name	=	=

tablas CDF RAW

Propiedad	Delegación	Local
Name	=	=

filas CDF RAW

Propiedad	Delegación	Local
Key	=	=, FilterFunction
LastUpdatedTime	Comparación	Comparación

Funciones OData compatibles

AssetsRoots

Obtener los activos raíz de un proyecto CDF.

Parámetro	Tipo	Descripción
Sin parámetros

AssetsSearch

Buscar activos en un proyecto CDF.

Parámetro	Tipo	Descripción
Search	Texto	Términos separados por espacios en blanco para buscar en los activos. Realiza una búsqueda difusa de máximo esfuerzo en los campos relevantes (actualmente name y description) para encontrar variantes de cualquier término de búsqueda. Ordena los resultados por relevancia.

EventsSearch

Buscar eventos en un proyecto CDF.

Parámetro	Tipo	Descripción
Search	Texto	Términos separados por espacios en blanco para buscar en los eventos. Realiza una búsqueda difusa de máximo esfuerzo en los campos relevantes (actualmente description) para encontrar variantes de cualquier término de búsqueda. Ordena los resultados por relevancia.

TimeseriesAggregate

Agrega puntos de datos de varias series temporales.

Parámetro	Tipo	Descripción
Tags	Texto	Una lista separada por comas de los identificadores de series temporales o los ID externos que se deben incluir en la consulta.
Granularity	Texto	La granularidad utilizada para obtener agregados de puntos de datos.
Start	Texto	Obtener puntos de datos a partir de este momento, inclusive.
End	Texto (opcional)	Obtener puntos de datos hasta este punto en el tiempo, pero sin incluirlo. Si no se proporciona ningún valor, el valor predeterminado es ahora.

TimeseriesSearch

Buscar series cronológicas en un proyecto CDF.

Parámetro	Tipo	Descripción
Search	Texto	Términos separados por espacios en blanco para buscar en las series cronológicas. Realiza una búsqueda difusa de máximo esfuerzo en los campos relevantes (actualmente name y description) para encontrar variantes de cualquier término de búsqueda y ordena los resultados por relevancia.