Servizio OData asset-centric
Connettere Cognite Data Fusion (CDF) come origine dati e utilizzare i client OData per eseguire query nonché trasformare e visualizzare i dati archiviati in risorse asset-centric di CDF.
Il servizio OData asset-centric consente di accedere alle risorse CDF quali assets, time series, events, files, sequences e dati RAW tramite un'API OData.
Il servizio OData asset-centric accetta gli URL con lo schema seguente:
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
Dove:
{cluster}: il nome del cluster CDF, ad esempio westeurope-1.{apiVersion}: la versione dell'API del servizio OData (la più recente è v1).{project}: il nome del progetto CDF, ad esempio publicdata.
Se si punta il client OData all'URL del servizio OData asset-centric corretto e si esegue l'autenticazione, il server restituisce una tabella con tutti i tipi asset-centric attualmente supportati dal servizio OData oltre alle funzioni OData supportate.
Filtro dei tipi di risorsa asset-centric
Il servizio OData asset-centric può eseguire il push dei filtri in CDF. In questo modo, si migliorano le prestazioni assicurandosi che il filtro avvenga sul lato server, riducendo la quantità di dati trasmessi al client.
Opzioni di filtro
- Pushdown: Funzioni di filtro di cui è possibile eseguire il push nel backend
CDF. Si tratta del filtro più efficiente.
- Locale: Filtro eseguito dal servizio
OData prima di restituire il risultato al client. Meno efficiente del pushdown.
- Lato client: Filtro eseguito dal client dopo il recupero dei dati. Il meno efficiente.
Definizioni
- FilterFunctions:
Contains, StartsWith e EndsWith.
- Confronto:
<, <=, >, >= e =.
- Ricerca: utilizza l'API di ricerca e potrebbe richiedere un filtro locale aggiuntivo.
La ricerca restituisce un numero limitato di righe ed è possibile che non si ricevano tutti i dati corrispondenti in CDF.
Assets (Asset)
| Proprietà | Pushdown | Locale |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Ricerca | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Confronto | Confronto |
LastUpdatedTime | Confronto | Confronto |
Time series (Serie temporali)
| Proprietà | Pushdown | Locale |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Ricerca | =, FilterFunctions |
IsString | = | = |
MetaData | = | |
Unit | = | = |
IsStep | = | = |
AssetId | = | = |
SecurityCategories | | |
DataSetId | = | = |
CreatedTime | Confronto | Confronto |
LastUpdatedTime | Confronto | Confronto |
Data point (Punto dati)
| Proprietà | Pushdown | Locale |
|---|
Id | = | = |
TimeStamp | Confronto | Confronto |
Events (Eventi)
| Proprietà | Pushdown | Locale |
|---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Ricerca | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Confronto | Confronto |
EndTime | Confronto | Confronto |
CreatedTime | Confronto | Confronto |
LastUpdatedTime | Confronto | Confronto |
AssetIds | Contains | Contains |
Files (File)
| Proprietà | Pushdown | Locale |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Source | = | = |
MimeType | = | = |
MetaData | | |
DataSetId | = | = |
SourceCreatedTime | Confronto | Confronto |
SourceModifiedTime | Confronto | Confronto |
CreatedTime | Confronto | Confronto |
LastUpdatedTime | Confronto | Confronto |
UploadedTime | Confronto | Confronto |
Uploaded | = | = |
AssetIds | Contains | Contains |
Sequences (Sequenze)
| Proprietà | Pushdown | Locale |
|---|
Id | * | = |
ExternalId | StartsWith | =, StartsWith |
Name | =, Search | =, FilterFunctions |
Description | =, Search | =, FilterFunctions |
MetaData | | |
AssetId | = | = |
DataSetId | = | = |
CreatedTime | Confronto | Confronto |
LastUpdatedTime | Confronto | Confronto |
Columns | | |
Supportato tramite la sintassi Sequences(id).
Database CDF RAW
| Proprietà | Pushdown | Locale |
|---|
Name | = | = |
Tabelle CDF RAW
| Proprietà | Pushdown | Locale |
|---|
Name | = | = |
Righe CDF RAW
| Proprietà | Pushdown | Locale |
|---|
Key | = | =, FilterFunction |
LastUpdatedTime | Confronto | Confronto |
Funzioni OData supportate
AssetsRoots
Recuperare gli asset radice per un progetto CDF.
| Parametro | Tipo | Descrizione |
|---|
| Nessun parametro | | |
AssetsSearch
Cercare asset in un progetto CDF.
| Parametro | Tipo | Descrizione |
|---|
Search | Testo | Termini separati da spazi da cercare negli asset. Esegue la migliore ricerca fuzzy possibile nei campi rilevanti (attualmente name e description) per variazioni di termini di ricerca. Ordina i risultati per rilevanza. |
EventsSearch
Cerca eventi in un progetto CDF.
| Parametro | Tipo | Descrizione |
|---|
Search | Testo | Termini separati da spazi da cercare negli eventi. Esegue la migliore ricerca fuzzy possibile nei campi rilevanti (attualmente description) per variazioni di termini di ricerca. Ordina i risultati per rilevanza. |
TimeseriesAggregate
Aggrega i punti dati da più serie temporali.
| Parametro | Tipo | Descrizione |
|---|
Tags | Testo | Un elenco separato da virgole di ID serie temporali o ID esterni da includere nella query. |
Granularity | Testo | La granularità utilizzata per recuperare gli aggregati di punti dati. |
Start | Testo | Ottiene punti dati a partire da questo momento (incluso). |
End | Testo (facoltativo) | Ottiene punti dati fino a questo momento (escluso). Se non viene fornito alcun valore, si utilizza il momento attuale. |
TimeseriesSearch
Cerca serie temporali in un progetto CDF.
| Parametro | Tipo | Descrizione |
|---|
Search | Testo | Termini separati da spazi da cercare nelle serie temporali. Esegue la migliore ricerca fuzzy possibile nei campi rilevanti (attualmente name e description) per variazioni di termini di ricerca e ordina i risultati per rilevanza. |