Assetgerichte OData-service
Verbind Cognite Data Fusion (CDF) als gegevensbron en gebruik OData-clients om de opgeslagen gegevens in assetgerichte CDF-resources op te vragen, te transformeren en te visualiseren.
Met de assetgerichte OData-service hebt u toegang tot CDF-resources zoals assets, time series, events, files, sequences en RAW-gegevens via een OData API.
De assetgerichte OData-service accepteert URL's met het volgende schema:
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
Waarbij het volgende geldt:
{cluster}: de naam van het CDF-cluster, bijvoorbeeld westeurope-1.{apiVersion}: de versie van de OData-service-API (de nieuwste is v1).{project}: de naam van het CDF-project, bijvoorbeeld publicdata.
Als u de OData-client naar de juiste assetgerichte OData-URL verwijst en authenticeert, retourneert de server een tabel met alle assetgerichte typen die momenteel door de OData-service worden ondersteund naast ondersteunde OData-functies.
Assetgerichte resourcetypen filteren
De assetgerichte OData-service kan filters pushen naar CDF. Dit verbetert de prestaties doordat het filteren plaatsvindt op de server, waardoor er minder gegevens naar de client worden verzonden.
Filteropties
- Pushdown: Filterfuncties die naar de
CDF-backend worden gepusht. Dit is de meest efficiënte manier van filteren.
- Lokaal: Het filteren wordt door de
OData-service uitgevoerd voordat het resultaat naar de client wordt geretourneerd. Minder efficiënt dan pushdown.
- Op de client: Het filteren wordt uitgevoerd door de client nadat de gegevens zijn opgehaald. Het minst efficiënt.
Definities
- Filterfuncties:
Contains, StartsWith en EndsWith.
- Vergelijking:
<, <=, >, >= en =.
- Zoeken: maakt gebruik van de zoek-API en mogelijk zijn aanvullende lokale filters vereist.
Met Zoeken wordt een beperkt aantal rijen geretourneerd en mogelijk ontvangt u niet alle overeenkomende gegevens in CDF.
Assets (Assets)
| Eigenschap | Pushdown | Lokaal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Zoeken | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Vergelijking | Vergelijking |
LastUpdatedTime | Vergelijking | Vergelijking |
Time series (Tijdreeksen)
| Eigenschap | Pushdown | Lokaal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Zoeken | =, FilterFunctions |
IsString | = | = |
MetaData | = | |
Unit | = | = |
IsStep | = | = |
AssetId | = | = |
SecurityCategories | | |
DataSetId | = | = |
CreatedTime | Vergelijking | Vergelijking |
LastUpdatedTime | Vergelijking | Vergelijking |
Data point (Gegevenspunt)
| Eigenschap | Pushdown | Lokaal |
|---|
Id | = | = |
TimeStamp | Vergelijking | Vergelijking |
Events (Gebeurtenissen)
| Eigenschap | Pushdown | Lokaal |
|---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Zoeken | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Vergelijking | Vergelijking |
EndTime | Vergelijking | Vergelijking |
CreatedTime | Vergelijking | Vergelijking |
LastUpdatedTime | Vergelijking | Vergelijking |
AssetIds | Contains | Contains |
Files (Bestanden)
| Eigenschap | Pushdown | Lokaal |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Source | = | = |
MimeType | = | = |
MetaData | | |
DataSetId | = | = |
SourceCreatedTime | Vergelijking | Vergelijking |
SourceModifiedTime | Vergelijking | Vergelijking |
CreatedTime | Vergelijking | Vergelijking |
LastUpdatedTime | Vergelijking | Vergelijking |
UploadedTime | Vergelijking | Vergelijking |
Uploaded | = | = |
AssetIds | Contains | Contains |
Sequences (Reeksen)
| Eigenschap | Pushdown | Lokaal |
|---|
Id | * | = |
ExternalId | StartsWith | =, StartsWith |
Name | =, Search | =, FilterFunctions |
Description | =, Search | =, FilterFunctions |
MetaData | | |
AssetId | = | = |
DataSetId | = | = |
CreatedTime | Vergelijking | Vergelijking |
LastUpdatedTime | Vergelijking | Vergelijking |
Columns | | |
Ondersteund via de Sequences(id)-syntaxis.
CDF RAW-databases
| Eigenschap | Pushdown | Lokaal |
|---|
Name | = | = |
CDF RAW-tabellen
| Eigenschap | Pushdown | Lokaal |
|---|
Name | = | = |
CDF RAW-rijen
| Eigenschap | Pushdown | Lokaal |
|---|
Key | = | =, FilterFunction |
LastUpdatedTime | Vergelijking | Vergelijking |
Ondersteunde OData-functies
AssetsRoots
Haal de hoofdassets op voor een CDF-project.
| Parameter | Type | Beschrijving |
|---|
| Geen parameters | | |
AssetsSearch
Zoek assets in een CDF-project.
| Parameter | Type | Beschrijving |
|---|
Search | Tekst | Door spaties gescheiden termen waarnaar moet worden gezocht in assets. Voert een fuzzy zoekopdracht uit in relevante velden (momenteel name en description) naar variaties van zoektermen. Sorteert resultaten op relevantie. |
EventsSearch
Zoek naar gebeurtenissen in een CDF-project.
| Parameter | Type | Beschrijving |
|---|
Search | Tekst | Met spaties gescheiden termen om naar te zoeken in gebeurtenissen. Voert een fuzzy zoekopdracht uit in relevante velden (momenteel description) naar variaties van zoektermen. Sorteert resultaten op relevantie. |
TimeseriesAggregate
Voeg gegevenspunten uit meerdere tijdreeksen samen.
| Parameter | Type | Beschrijving |
|---|
Tags | Tekst | Een door komma's gescheiden lijst met tijdreeks-ID's of externe ID's die in de query moeten worden opgenomen. |
Granularity | Tekst | De granulariteit die wordt gebruikt om gegevenspuntaggregaties op te halen. |
Start | Tekst | Haal gegevenspunten op vanaf en tot en met dit tijdstip. |
End | Tekst (optioneel) | Haal gegevenspunten op tot aan dit tijdstip (dus niet dit tijdstip zelf). Als er geen waarde wordt opgegeven, wordt standaard 'nu' gebruikt. |
TimeseriesSearch
Zoek tijdreeksen in een CDF-project.
| Parameter | Type | Beschrijving |
|---|
Search | Tekst | Door spaties gescheiden termen om naar te zoeken in tijdreeksen. Voert een fuzzy zoekopdracht uit in relevante velden (momenteel name en description) naar variaties van zoektermen en sorteert de resultaten op relevantie. |