Asset-centric OData-tjeneste
Koble til Cognite Data Fusion (CDF) som datakilde, og bruk OData-klienter til å utføre spørringer på, endre og visualisere data lagret i CDF-ressurser som er asset-centric.
Den asset-centric ODatatjenesten lar deg bruke CDF-ressurser som assets, time series, events, files, sequences og RAW-data via et OData-API.
Den asset-centric OData tjenesten godtar nettadresser med følgende skjema:
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
Der:
{cluster}: navnet på CDF-klyngen, f.eks. westeurope-1.{apiVersion}: versjon av OData-tjeneste-API (nyeste er v1).{project}: navnet på CDF-prosjektet, f.eks. publicdata.
Hvis du peker OData-klienten til riktig asset-centric ODatanettadresse og autentiserer deg, returnerer serveren en tabell med alle asset-centric typer som for øyeblikket støttes av OData-tjenesten, i tillegg til OData-funksjoner som støttes.
Filtrere asset-centric ressurstyper
Den asset-centric OData-tjenesten kan skyve filtre ned til CDF. Dette øker ytelsen ved å sikre at filtrering skjer på serversiden ved å redusere mengden data som sendes til klienten.
Filtreringsalternativer
- Pushdown: filterfunksjoner som skyves ned til
CDF-backendserveren. Dette er den mest effektive filtreringen.
- Lokal: filtrering utført via
OData-tjenesten før resultatene returneres til klienten. Mindre effektiv enn pushdown.
- Klientside: Filtrering utført av klienten etter at data er hentet. Minst effektiv.
Definisjoner
- FilterFunctions:
Contains, StartsWith og EndsWith.
- Sammenligning:
<, <=, >, >= og =.
- Søk: Bruker søke-API-et og kan kreve ytterligere lokal filtrering.
Søket returnerer et begrenset antall rader, og det kan hende du ikke får alle samsvarende data i CDF.
Assets (tagger)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Søk | =, FilterFunctions |
Description | Søk | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Sammenligning | Sammenligning |
LastUpdatedTime | Sammenligning | Sammenligning |
Time series (tidsserier)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Søk | =, FilterFunctions |
Description | Søk | =, FilterFunctions |
IsString | = | = |
MetaData | = | |
Unit | = | = |
IsStep | = | = |
AssetId | = | = |
SecurityCategories | | |
DataSetId | = | = |
CreatedTime | Sammenligning | Sammenligning |
LastUpdatedTime | Sammenligning | Sammenligning |
Data point (datapunkt)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
TimeStamp | Sammenligning | Sammenligning |
Events (hendelser)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Søk | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Sammenligning | Sammenligning |
EndTime | Sammenligning | Sammenligning |
CreatedTime | Sammenligning | Sammenligning |
LastUpdatedTime | Sammenligning | Sammenligning |
AssetIds | Contains | Contains |
Files (filer)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Søk | =, FilterFunctions |
Source | = | = |
MimeType | = | = |
MetaData | | |
DataSetId | = | = |
SourceCreatedTime | Sammenligning | Sammenligning |
SourceModifiedTime | Sammenligning | Sammenligning |
CreatedTime | Sammenligning | Sammenligning |
LastUpdatedTime | Sammenligning | Sammenligning |
UploadedTime | Sammenligning | Sammenligning |
Uploaded | = | = |
AssetIds | Contains | Contains |
Sequences (sekvenser)
| Egenskap | Pushdown | Lokal |
|---|
Id | * | = |
ExternalId | StartsWith | =, StartsWith |
Name | =, Søk | =, FilterFunctions |
Description | =, Søk | =, FilterFunctions |
MetaData | | |
AssetId | = | = |
DataSetId | = | = |
CreatedTime | Sammenligning | Sammenligning |
LastUpdatedTime | Sammenligning | Sammenligning |
Columns | | |
Støttes via Sequences(id)-syntaksen.
CDF RAW-databaser
| Egenskap | Pushdown | Lokal |
|---|
Name | = | = |
CDF RAW-tabeller
| Egenskap | Pushdown | Lokal |
|---|
Name | = | = |
CDF RAW-rader
| Egenskap | Pushdown | Lokal |
|---|
Key | = | =, FilterFunction |
LastUpdatedTime | Sammenligning | Sammenligning |
OData-funksjoner som støttes
AssetsRoots
Hent rot-taggene for et CDF-prosjekt.
| Parameter | Type | Beskrivelse |
|---|
| Ingen parametere | | |
AssetsSearch
Søk etter tagger i et CDF-prosjekt.
| Parameter | Type | Beskrivelse |
|---|
Search | Tekst | Ord atskilt med mellomrom det skal søkes etter i tagger. Utfører et best mulig fuzzy-søk i relevante felt (for øyeblikket name og description) etter variasjoner av søkeord. Resultatene sorteres etter relevans. |
EventsSearch
Søk etter hendelser i et CDF-prosjekt.
| Parameter | Type | Beskrivelse |
|---|
Search | Tekst | Ord atskilt med mellomrom det skal søkes etter i hendelser. Utfører et best mulig fuzzy-søk i relevante felt (for øyeblikket description) etter variasjoner av søkeord. Resultatene sorteres etter relevans. |
TimeseriesAggregate
Aggregere datapunkter fra flere tidsserier.
| Parameter | Type | Beskrivelse |
|---|
Tags | Tekst | En kommadelt liste med tidsserie-ID-er eller eksterne ID-er som skal inkluderes i spørringen. |
Granularity | Tekst | Detaljnivået som brukes til å hente datapunkt-aggregater. |
Start | Tekst | Hent datapunkter fra og med og til og med dette tidspunktet. |
End | Tekst (valgfritt) | Hent datapunkter frem til, men ikke inkludert dette tidspunktet. Hvis ingen verdi er oppgitt, settes standardverdien til nå. |
TimeseriesSearch
Søk etter tidsserier i et CDF-prosjekt.
| Parameter | Type | Beskrivelse |
|---|
Search | Tekst | Ord atskilt med mellomrom det skal søkes etter i tidsserier. Utfører et best mulig fuzzy-søk i relevante felt (for øyeblikket name og description) etter variasjoner av søkeord sorterer resultatene etter relevans. |