Service OData axé sur les actifs
Connectez Cognite Data Fusion (CDF) comme source de données et utilisez des clients OData pour interroger, transformer et visualiser des données stockées dans des ressources CDF axées sur les actifs.
Le service OData axé sur les actifs permet d’accéder à des ressources CDF telles que des assets, des time series, des events, des files,des sequences et des données RAW via une API OData.
Le service OData axé sur les actifs accepte les URL présentant le schéma suivant :
https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}
Où :
{cluster} : le nom du cluster CDF, par exemple, westeurope-1.{apiVersion} : la version de l’API du service OData (la version la plus récente est v1).{project} : le nom du projet CDF, par exemple, publicdata.
Si vous dirigez le client OData vers l’URL OData appropriée du service axé sur les actifs et vous authentifiez correctement, le serveur renvoie un tableau contenant tous les types de ressources axés sur les actifs actuellement pris en charge par le service OData en plus des fonctions OData prises en charge.
Filtrage des types de ressources axés sur les actifs
Le service OData axé sur les actifs peut envoyer des filtres (via une transmission de type Pushdown) à destination de CDF. Cela permet d’améliorer les performances en s’assurant que le filtrage ait lieu du côté serveur, ce qui réduit la quantité de données transmises au client.
Options de filtrage
- Pushdown : Filtrage des fonctions qui sont envoyées au dorsal
CDF. Il s’agit du filtrage le plus efficace.
- Local : Filtrage réalisé par le service
OData avant de renvoyer les résultats au client. Moins efficace que le filtrage Pushdown.
- Côté client : Filtrage réalisé par le client après récupération des données. Moins efficace.
Définitions
- FilterFunctions (Fonctions de filtrage) :
Contains, StartsWith et EndsWith.
- Comparison (Comparaison) :
<, <=, >, >= et =.
- Search (Recherche) : utilise l’API de recherche et peut nécessiter un filtrage local supplémentaire.
La recherche retourne un nombre de lignes limité, et vous ne recevez pas forcément toutes les données correspondantes dans CDF.
Assets (actifs)
| Propriété | Pushdown | Local |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Recherche | =, FilterFunctions |
ParentId | = | = |
ParentExternalId | = | = |
DataSetId | = | = |
Source | = | = |
MetaData | = | |
RootId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Time series (séries temporelles)
| Propriété | Pushdown | Local |
|---|
Id | = | = |
ExternalId | =, StartsWith | =, FilterFunctions |
Name | =, Search | =, FilterFunctions |
Description | Search | =, FilterFunctions |
IsString | = | = |
MetaData | = | |
Unit | = | = |
IsStep | = | = |
AssetId | = | = |
SecurityCategories | | |
DataSetId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Data point (point de données)
| Propriété | Pushdown | Local |
|---|
Id | = | = |
TimeStamp | Comparison | Comparison |
Events (événements)
| Propriété | Pushdown | Local |
|---|
Id | = | = |
ExternalId | =, StartsWith | FilterFunctions |
Description | Recherche | =, FilterFunctions |
Source | = | = |
Type | = | = |
SubType | = | = |
MetaData | = | |
DataSetId | = | = |
StartTime | Comparison | Comparison |
EndTime | Comparison | Comparison |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
AssetIds | Contains | Contains |
Files (fichiers)
| Propriété | 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 (séquences)
| Propriété | Pushdown | Local |
|---|
Id | * | = |
ExternalId | StartsWith | =, StartsWith |
Name | =, Search | =, FilterFunctions |
Description | =, Search | =, FilterFunctions |
MetaData | | |
AssetId | = | = |
DataSetId | = | = |
CreatedTime | Comparison | Comparison |
LastUpdatedTime | Comparison | Comparison |
Columns | | |
Prise en charge via la syntaxe Sequences(id).
Bases de données CDF RAW
| Propriété | Pushdown | Local |
|---|
Name | = | = |
Tableaux CDF RAW
| Propriété | Pushdown | Local |
|---|
Name | = | = |
Rangées CDF RAW
| Propriété | Pushdown | Local |
|---|
Key | = | =, FilterFunction |
LastUpdatedTime | Comparison | Comparison |
Fonctions OData prises en charge
AssetsRoots (actifs racine)
Récupère les actifs racine pour un projet CDF.
| Paramètre | Type | Description |
|---|
| Aucun paramètre | | |
AssetsSearch (recherche d’actifs)
Recherche des actifs dans un projet CDF.
| Paramètre | Type | Description |
|---|
Search | Texte | Termes (séparés par des espaces) utilisés pour lancer une recherche dans des actifs. S’efforce de trouver des variantes des termes de recherche en effectuant une recherche approximative dans les champs appropriés (name et description actuellement). Classe les résultats par degré de pertinence. |
EventsSearch (recherche d’événements)
Recherche des événements dans un projet CDF.
| Paramètre | Type | Description |
|---|
Search | Texte | Termes (séparés par des espaces) utilisés pour lancer une recherche dans des événements. S’efforce de trouver des variantes des termes de recherche en effectuant une recherche approximative dans les champs appropriés (description actuellement). Classe les résultats par degré de pertinence. |
TimeseriesAggregate (agrégat de séries temporelles)
Agrège des points de données à partir de plusieurs séries temporelles.
| Paramètre | Type | Description |
|---|
Tags | Texte | Liste d’ID de séries temporelles ou d’ID externes (séparés par des virgules) à inclure dans la requête. |
Granularity | Texte | Niveau granulaire utilisé pour récupérer des agrégats de points de données. |
Start | Texte | Obtention des points de données à partir d’un moment donné dans le temps (inclus). |
End | Texte (facultatif) | Obtention des points de données jusqu’à un moment donné dans le temps (exclus). Si vous omettez de spécifier ce paramètre, la valeur appliquée par défaut est « maintenant ». |
TimeseriesSearch (recherche de séries temporelles)
Recherche des séries temporelles dans un projet CDF.
| Paramètre | Type | Description |
|---|
Search | Texte | Termes (séparés par des espaces) utilisés pour lancer une recherche dans des séries temporelles. S’efforce de trouver des variantes des termes de recherche en effectuant une recherche approximative dans les champs appropriés (name et description actuellement), puis classe les résultats par degré de pertinence. |