Fonctions Power BI REST API

Cet article traite des fonction Power BI REST API.

Bêta

Les fonctionnalités décrites dans cette section font actuellement l’objet de tests bêta avec certains clients, et sont susceptibles d’être modifiées.

GetCDF

Utilisez cette fonction pour récupérer des données des API CDF à l’aide de la méthode HTTP GET. La fonction procède à l’auto-pagination de CDF jusqu’à la fermeture du curseur de requête. Pour garantir des performances optimales, reportez-vous à la documentation de l’API Cognite afin de connaître les points de terminaison compatibles avec cette méthode HTTP et la taille de page maximum prise en charge pour chaque point de terminaison.

Paramètre	Type	Description
url	Texte	Le chemin d’accès à l’URL permettant d’effectuer la requête. Il figure juste après le nom du projet. Exemples : "/timeseries", "/assets".

PostCDF

Utilisez cette fonction pour récupérer des données des API CDF à l’aide de la méthode HTTP POST. La fonction procède à l’auto-pagination de CDF jusqu’à la fermeture du curseur de requête. Pour garantir des performances optimales, reportez-vous à la documentation de l’API Cognite afin de connaître les points de terminaison compatibles avec cette méthode HTTP.

Paramètre	Type	Description
url	Texte	Le chemin d’accès à l’URL permettant d’effectuer la requête. Il figure juste après le nom du projet. Exemples : "/timeseries/list", "/assets/list".
body	Texte	Représentation textuelle du corps JSON à envoyer avec la requête. Exemples : "{}", "{"limit": 1000}". Définissez le paramètre limit (si celui-ci est disponible) sur la valeur maximale prise en charge pour le point de terminaison. Pour garantir des performances optimales, reportez-vous à la documentation de l’API Cognite. Lorsque vous faites appel à cette fonction avec Power BI, la requête se présente sous forme d’une zone de texte de plusieurs lignes. Il n’est pas nécessaire d’utiliser une autre paire de guillemets doubles pour entourer les caractères entre guillemets doubles. Si le corps JSON fourni n’est pas valide, la fonction renvoie une erreur du type CogniteConnectorError.

remarque

La fonction PostCDF offre une auto-pagination pour les requêtes simples. Celles-ci s’attendent à ce que le curseur se trouve en haut du corps de la requête. Pour formuler des requêtes plus complexes, il convient d’écrire une logique de pagination personnalisée à l’aide du langage de programmation M de Power Query. Reportez-vous à l’article traitant des fonctions Power Query et des exemples de requêtes.

GraphQL

Utilisez cette fonction pour récupérer des données d’un modèle de données CDF à l’aide de GraphQL.

Paramètre	Type	Description
space	Texte	L’ID externe de l’espace du modèle de données.
datamodel	Texte	L’ID externe du modèle de données.
version	Texte	La version du modèle de données.
query	Texte	Représentation textuelle de la requête GraphQL à envoyer lors de l’exécution de la requête. N’oubliez pas d’inclure after:$cursor and pageInfo { hasNextPage endCursor } dans la requête pour activer l’auto-pagination. Définissez le paramètre first sur 1 000 (limite maximale prise en charge) pour garantir des performances optimales. Exemple : "query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}". Lorsque vous faites appel à cette fonction avec Power BI, la requête se présente sous forme d’une zone de texte de plusieurs lignes. Il n’est pas nécessaire d’utiliser une autre paire de guillemets doubles pour entourer les caractères entre guillemets doubles. Si la requête GraphQL fournie n’est pas valide, la fonction renvoie une erreur du type CogniteAPIError.
variables	Texte	Représentation textuelle des variables JSON à envoyer lors de l’exécution de la requête. Exemple : "{""country"": ""Norway""}". N’insérez pas la variable cursor dans le paramètre variables. Elle est gérée automatiquement par le connecteur. Si le corps JSON fourni n’est pas valide, la fonction renvoie une erreur du type CogniteConnectorError.

remarque

La fonction GraphQL offre une auto-pagination pour les requêtes GraphQL contenant une seule expression de requête et une cible de pagination, identifiées par les champs after: $cursor et pageInfo { hasNextPage endCursor }. Pour formuler des requêtes plus complexes, il convient d’écrire une logique de pagination personnalisée à l’aide du langage de programmation M de Power Query. Pour en savoir plus à ce sujet, reportez-vous à l’article traitant des fonctions Power Query et des exemples de requêtes. Avant d’utiliser les requêtes et les variables dans Power BI, assurez-vous toujours qu’elles sont correctes en les testant avec l’CDF Query Explorer.

ODataCDF

Utilisez cette fonction pour récupérer des données des services OData de Cognite.

Paramètre	Type	Description
url	Texte	Le chemin d’accès à l’URL (comprenant le nom du projet) permettant d’effectuer la requête OData. Exemples : "publicdata", "publicdata/Timeseries".
apiVersion	Texte (facultatif)	La version de l’API du service OData à utiliser avec la requête. Par défaut : "v1". La version la plus récente du service OData axé sur les actifs est "v1". Dans le cas du service OData de modélisation des données, la version la plus récente est "20230821".

ODataDataModel

Utilisez cette fonction pour récupérer des données d’un modèle de données dans CDF à l’aide du service OData de modélisation des données.

Paramètre	Type	Description
space	Texte	L’ID externe de l’espace du modèle de données.
datamodel	Texte	L’ID externe du modèle de données.
version	Texte	La version du modèle de données.
apiVersion	Texte (facultatif)	La version de l’API du service OData à utiliser lors de l’exécution de la requête. Par défaut : "20230821". La version la plus récente du service OData de modélisation des données est "20230821".