Tillgångscentrerad OData Service
Anslut Cognite Data Fusion (CDF) som datakälla och använd OData-klienter för att fråga, transformera och visualisera data lagrade i CDF asset-centric-resurser.
Med asset-centric OData-tjänsten kan du komma åt CDF-resurser som assets, time series, events, files, sequences och RAW data via en OData API.
Asset-centric OData-tjänsten accepterar URL:er med följande schema:
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
Där:
{cluster}: namnet på CDF-kluster, t.ex. westeurope-1.{apiVersion}: versionen av OData-tjänste-API:n (senaste är v1).{project}: namnet på CDF-projektet t.ex. publicdata.
Om du dirigerar OData-klienten till den rätta asset-centric OData-URL:n och autentiserar, returnerar servern en tabell med alla tillgångscentrerade typer som för närvarande stöds av OData-tjänsten förutom OData-funktioner som stöds.
Filtrera asset-centric-resurstyper
Asset-centric OData Service kan föra filtren ned till CDF. Detta förbättrar prestandan genom att säkerställa att filtrering sker på serversidan och minskar mängden data som överförs till klienten.
Filtreringsalternativ
- Pushdown: Filterfunktioner som trycks ner till
CDF-grundsystemet. Detta är den mest effektiva filtreringen.
- Lokal: Filtrering görs av
OData-tjänsten innan resultatet returneras till klienten. Mindre effektivt utan pushdown.
- Klientsidan: Filtrering görs av klienten när data har hämtats. Minst effektivt.
Definitioner
- Filterfunktioner:
Contains, StartsWith och EndsWith.
- Jämförelse:
<, <=, >, >= och =.
- Sökning: använder söknings-API:n och kan kräva ytterligare lokal filtrering.
Sökning returnerar ett begränsat antal rader och du kanske inte får all matchande data i CDF.
Assets (tillgångar)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Sök | =, FilterFunctions |
Description | Sök | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Jämförelse | Jämförelse |
LastUpdatedTime | Jämförelse | Jämförelse |
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 | Jämförelse | Jämförelse |
LastUpdatedTime | Jämförelse | Jämförelse |
Data point (datapunkt)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
TimeStamp | Jämförelse | Jämförelse |
Events (händelser)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Sök | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Jämförelse | Jämförelse |
EndTime | Jämförelse | Jämförelse |
CreatedTime | Jämförelse | Jämförelse |
LastUpdatedTime | Jämförelse | Jämförelse |
AssetIds | Contains | Contains |
Files (filer)
| Egenskap | Pushdown | Lokal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Sök | =, FilterFunctions |
Source | = | = |
MimeType | = | = |
MetaData | | |
DataSetId | = | = |
SourceCreatedTime | Jämförelse | Jämförelse |
SourceModifiedTime | Jämförelse | Jämförelse |
CreatedTime | Jämförelse | Jämförelse |
LastUpdatedTime | Jämförelse | Jämförelse |
UploadedTime | Jämförelse | Jämförelse |
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 | Jämförelse | Jämförelse |
LastUpdatedTime | Jämförelse | Jämförelse |
Columns | | |
Stöds via Sequences(id)-syntaxen.
CDF RAW-databaser
| Egenskap | Pushdown | Lokal |
|---|
Name | = | = |
CDF RAW-tabeller
| Egenskap | Pushdown | Lokal |
|---|
Name | = | = |
CDF RAW-rader
| Egenskap | Pushdown | Lokal |
|---|
Key | = | =, FilterFunction |
LastUpdatedTime | Jämförelse | Jämförelse |
OData-funktioner som stöds
AssetsRoots
Hämta rottillgångarna för ett CDF-projekt.
| Parameter | Typ | Beskrivning |
|---|
| Inga parametrar | | |
AssetsSearch
Sök efter tillgångar i ett CDF-projekt.
| Parameter | Typ | Beskrivning |
|---|
Search | Text | Termer avgränsade med blanksteg för sökning i tillgångar. Utför en approximativ sökning av viss kvalitet, i relevanta fält (för närvarande name och description) efter variationer av söktermer. Ordnar resultat efter relevans. |
EventsSearch
Sök efter händelser i ett CDF-projekt.
| Parameter | Typ | Beskrivning |
|---|
Search | Text | Blankstegsavgränsade termer att söka efter i händelser. Utför en approximativ sökning av viss kvalitet, i relevanta fält (för närvarande description) efter variationer av söktermer. Ordnar resultat efter relevans. |
TimeseriesAggregate
Aggregerade datapunkter från flera tidsserier.
| Parameter | Typ | Beskrivning |
|---|
Tags | Text | En kommaavgränsad lista över tidsserie-ID:n eller externa ID:n som ska ingå i frågan. |
Granularity | Text | Granulariteten som används för att hämta datapunktsaggregat. |
Start | Text | Hämta datapunkter från och inklusive denna tidpunkt. |
End | Text (valfritt) | Hämta datapunkter fram till, men inte inklusive denna tidpunkt. Om inget värde anges används värdet nu. |
TimeseriesSearch
Sök efter tidsserier i ett CDF-projekt.
| Parameter | Typ | Beskrivning |
|---|
Search | Text | Blankstegsavgränsade termer att söka efter i tidsserier. Utför en approximativ sökning av viss kvalitet, i relevanta fält (för närvarande name och description) efter variationer av söktermer och ordnar resultat efter relevans. |