Uz aktīviem vērsts OData pakalpojums
Savienojiet Cognite Data Fusion (CDF) kā datu avotu un izmantojiet OData klientus, lai meklētu, pārveidotu un vizualizētu datus, kas glabājas CDF uz aktīviem vērstos resursos.
Uz aktīviem vērstais OData pakalpojums ļauj piekļūt tādiem CDF resursiem kā assets time series, events, files, sequences un RAW datiem, izmantojot OData API.
Uz aktīviem vērstais OData pakalpojums pieņem vietrāžus URL ar šādu shēmu:
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
Kur:
{cluster}
: CDF kopas nosaukums, piem., westeurope-1
.
{apiVersion}
: OData pakalpojuma API versija (jaunākā ir v1
).
{project}
: CDF projekta nosaukums, piem., publicdata
.
Ja jūs norādāt OData klientam uz pareizu uz aktīviem vērstu OData URL un autentificējat, serveris atgriež tabulu ar visiem uz aktīviem vērstiem tipiem, ko OData pakalpojums pašlaik atbalsta līdztekus atbalstītajām OData funkcijām.
Uz aktīviem vērstu resursu veidu filtrēšana
Uz aktīviem vērstais OData pakalpojums var nosūtīt filtrus uz CDF. Tas uzlabo veiktspēju, nodrošinot, ka filtrēšana notiek servera pusē, un samazina klientam pārraidīto datu apjomu.
Filtrēšanas opcijas
- Pushdown: filtra funkcijas, kas tiek nosūtītas uz pakalpojuma
CDF aizmugursistēmu. Šī ir visefektīvākā filtrēšana.
- Local: filtrēšana, ko veic pakalpojums
OData pirms rezultāta atgriešanas klientam. Mazāk efektīva par Pushdown.
- Klienta pusē: filtrēšanu klients veic pēc datu izgūšanas. Visneefektīvākā.
Definīcijas
- FilterFunctions:
Contains
, StartsWith
un EndsWith
.
- Comparison:
<
, <=
, >
, >=
un =
.
- Search: izmanto meklēšanas API, kā arī var būt nepieciešams papildus veikt lokālu filtrēšanu (Local).
Operācija Search atgriež ierobežotu rindu skaitu, taču var gadīties, ka platformā CDF nesaņemsiet visus atbilstošos datus.
Assets (Aktīvi)
Rekvizīts | Pushdown | Local |
---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Meklēt | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Time series (Laika rindas)
Rekvizīts | Pushdown | Local |
---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Meklēt | =, FilterFunctions |
IsString | = | = |
MetaData | = | |
Unit | = | = |
IsStep | = | = |
AssetId | = | = |
SecurityCategories | | |
DataSetId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Data point (Datu punkts)
Rekvizīts | Pushdown | Local |
---|
Id | = | = |
TimeStamp | Comparison | Comparison |
Events (Notikumi)
Rekvizīts | Pushdown | Local |
---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Meklēt | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Comparison | Comparison |
EndTime | Comparison | Comparison |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
AssetIds | Contains | Contains |
Files (Faili)
Rekvizīts | 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 (Sekvences)
Rekvizīts | Pushdown | Local |
---|
Id | * | = |
ExternalId | StartsWith | =, StartsWith |
Name | =, Search | =, FilterFunctions |
Description | =, Search | =, FilterFunctions |
MetaData | | |
AssetId | = | = |
DataSetId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Columns | | |
Atbalsta, izmantojot Sequences(id)
sintaksi.
CDF RAW datu bāzes
Rekvizīts | Pushdown | Local |
---|
Name | = | = |
CDF RAW tabulas
Rekvizīts | Pushdown | Local |
---|
Name | = | = |
CDF RAW rindas
Rekvizīts | Pushdown | Local |
---|
Key | = | =, FilterFunction |
LastUpdatedTime | Comparison | Comparison |
Atbalstītās OData funkcijas
AssetsRoots
Iegūst CDF projekta primāros aktīvus.
Parametrs | Tips | Apraksts |
---|
Nav parametru | | |
AssetsSearch
Meklē aktīvus CDF projektā.
Parametrs | Tips | Apraksts |
---|
Search | Teksts | Ar atstarpēm atdalīti termini, kurus jāmeklē aktīvos. Veic labāko aptuveno meklēšanu attiecīgajos laukos (pašlaik name un description ), lai atrastu jebkādus meklēto terminu variantus. Rezultātus iegūst pēc atbilstības. |
EventsSearch
Meklē notikumus CDF projektā.
Parametrs | Tips | Apraksts |
---|
Search | Teksts | Ar atstarpēm atdalīti termini, kuri jāmeklē notikumos. Veic labāko aptuveno meklēšanu attiecīgajos laukos (pašlaik description ), lai atrastu jebkādus meklēto terminu variantus. Rezultātus iegūst pēc atbilstības. |
TimeseriesAggregate
Apkopo datu punktus no vairākām laika rindām.
Parametrs | Tips | Apraksts |
---|
Tags | Teksts | Ar komatiem atdalītu laika rindu ID vai ārējo OD, kas jāiekļauj vaicājumā, saraksts. |
Granularity | Teksts | Granularitāte, ko izmanto, lai iegūtu datu punktu apkopojumus. |
Start | Teksts | Iegūst datu punktus, sākot no šī laika (to ieskaitot). |
End | Teksts (nav obligāts) | Iegūst datu punktus līdz šim brīdim (to neieskaitot). Ja vērtība nav norādīta, pēc noklusējuma tā ir šis brīdis. |
TimeseriesSearch
Meklē laika rindas CDF projektā.
Parametrs | Tips | Apraksts |
---|
Search | Teksts | Ar atstarpēm atdalīti termini, kas jāmeklē laika rindās. Veic labāko aptuveno meklēšanu attiecīgajos laukos (pašlaik name un description ), lai atrastu jebkādus meklēšanas terminu un pasūtījumu rezultātu variantus pēc atbilstības. |