Pāriet uz galveno saturu

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 pakalpojumsOData 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).
informācija

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ītsPushdownLocal
Id==
ExternalId=, StartsWith=, FilterFunctions
Name=, Search=, FilterFunctions
DescriptionMeklēt=, FilterFunctions
ParentId==
ParentExternalId==
DataSetId==
Source==
MetaData=
RootId==
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison

Time series (Laika rindas)

RekvizītsPushdownLocal
Id==
ExternalId=, StartsWith=, FilterFunctions
Name=, Search=, FilterFunctions
DescriptionMeklēt=, FilterFunctions
IsString==
MetaData=
Unit==
IsStep==
AssetId==
SecurityCategories
DataSetId==
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison

Data point (Datu punkts)

RekvizītsPushdownLocal
Id==
TimeStampComparisonComparison

Events (Notikumi)

RekvizītsPushdownLocal
Id==
ExternalId=, StartsWithFilterFunctions
DescriptionMeklēt=, FilterFunctions
Source==
Type==
SubType==
MetaData=
DataSetId==
StartTimeComparisonComparison
EndTimeComparisonComparison
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison
AssetIdsContainsContains

Files (Faili)

RekvizītsPushdownLocal
Id==
ExternalId=, StartsWith=, FilterFunctions
Name=, Search=, FilterFunctions
Source==
MimeType==
MetaData
DataSetId==
SourceCreatedTimeComparisonComparison
SourceModifiedTimeComparisonComparison
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison
UploadedTimeComparisonComparison
Uploaded==
AssetIdsContainsContains

Sequences (Sekvences)

RekvizītsPushdownLocal
Id*=
ExternalIdStartsWith=, StartsWith
Name=, Search=, FilterFunctions
Description=, Search=, FilterFunctions
MetaData
AssetId==
DataSetId==
CreatedTimeComparisonComparison
LastUpdatedTimeComparisonComparison
Columns
piezīme

Atbalsta, izmantojot Sequences(id) sintaksi.

CDF RAW datu bāzes

RekvizītsPushdownLocal
Name==

CDF RAW tabulas

RekvizītsPushdownLocal
Name==

CDF RAW rindas

RekvizītsPushdownLocal
Key==, FilterFunction
LastUpdatedTimeComparisonComparison

Atbalstītās OData funkcijas

AssetsRoots

Iegūst CDF projekta primāros aktīvus.

ParametrsTipsApraksts
Nav parametru

AssetsSearch

Meklē aktīvus CDF projektā.

ParametrsTipsApraksts
SearchTekstsAr 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ā.

ParametrsTipsApraksts
SearchTekstsAr 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.

ParametrsTipsApraksts
TagsTekstsAr komatiem atdalītu laika rindu ID vai ārējo OD, kas jāiekļauj vaicājumā, saraksts.
GranularityTekstsGranularitāte, ko izmanto, lai iegūtu datu punktu apkopojumus.
StartTekstsIegūst datu punktus, sākot no šī laika (to ieskaitot).
EndTeksts (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ā.

ParametrsTipsApraksts
SearchTekstsAr 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.