Power BI REST API-functies

In dit artikel worden de beschikbare Power BI REST API-functies beschreven.

Bèta

De functies die in dit gedeelte worden beschreven, worden momenteel in de bètafase getest door geselecteerde klanten en kunnen nog worden gewijzigd.

GetCDF

Gebruik deze functie om gegevens van CDF-API's op te halen via de HTTP GET-methode. De functie pagineert CDF automatisch totdat de aanvraagcursor leeg is. Voor optimale prestaties raadpleegt u de Cognite API-specificatie voor eindpunten die deze HTTP-methode ondersteunen, en de maximaal ondersteunde paginagrootte voor elk eindpunt.

Parameter	Type	Beschrijving
url	Tekst	Het URL-pad om de aanvraag te doen, beginnend direct na de projectnaam. Voorbeelden: "/timeseries", "/assets".

PostCDF

Gebruik deze functie om gegevens van CDF API's op te halen via de HTTP POST-methode. De functie pagineert CDF automatisch totdat de aanvraagcursor leeg is. Voor optimale prestaties raadpleegt u de Cognite API-specificatie voor eindpunten die deze HTTP-methode ondersteunen.

Parameter	Type	Beschrijving
url	Tekst	Het URL-pad om de aanvraag te doen, beginnend direct na de projectnaam. Voorbeelden: "/timeseries/list", "/assets/list".
body	Tekst	Een tekstweergave van de JSON-tekst die met de aanvraag moet worden meegestuurd. Voorbeelden: "{}", "{"limit": 1000}". Stel, indien beschikbaar, de parameter limit in op de maximaal ondersteunde waarde voor het eindpunt. Voor optimale prestaties raadpleegt u de Cognite API-specificatie. Wanneer u deze functie aanroept met Power BI, wordt de query weergegeven als een tekstgebied met meerdere regels. U hoeft geen escape te plaatsen bij dubbele aanhalingstekens. Als u een ongeldige JSON-tekst opgeeft, retourneert de functie een fout van het type CogniteConnectorError.

opmerking

De PostCDF-functie biedt automatische paginering voor eenvoudige aanvragen waarbij een cursor op het hoogste niveau van de aanvraagtekst wordt verwacht. Voor complexere aanvragen moet u een aangepaste pagineringslogica schrijven in de Power Query M-taal. Zie het artikel over Power Query-functies en voorbeeldquery's.

GraphQL

Gebruik deze functie om gegevens uit een CDF-gegevensmodel op te halen via GraphQL.

Parameter	Type	Beschrijving
space	Tekst	De externe ID van de gegevensmodelruimte.
datamodel	Tekst	De externe ID van het gegevensmodel.
version	Tekst	De versie van het gegevensmodel.
query	Tekst	Een tekstweergave van de GraphQL-query die moet worden verzonden wanneer de aanvraag wordt gedaan. Neem after:$cursor and pageInfo { hasNextPage endCursor } op in de query om automatische paginering in te schakelen. Voor optimale prestaties kunt u de parameter first instellen op 1000 (maximaal ondersteunde limiet). Voorbeeld: "query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}" Wanneer u deze functie aanroept met Power BI, wordt de query weergegeven als een tekstgebied met meerdere regels. U hoeft geen escape te plaatsen bij dubbele aanhalingstekens. Als u een ongeldige GraphQL-query opgeeft, retourneert de functie een fout van het type CogniteAPIError.
variables	Tekst	Een tekstweergave van de JSON-variabelen die moeten worden verzonden wanneer de aanvraag wordt gedaan. Voorbeeld: "{""country"": ""Norway""}" Neem de variabele cursor niet op in de variables-parameter. Dit wordt automatisch beheerd door de connector. Als u een ongeldige JSON-tekst opgeeft, retourneert de functie een fout van het type CogniteConnectorError.

opmerking

De GraphQL-functie biedt automatische paginering voor GraphQL-query's die slechts één query-expressie met één pagineringsdoel bevatten, geïdentificeerd door de velden after: $cursor en pageInfo { hasNextPage endCursor }. Voor complexere query's moet u een aangepaste pagineringslogica schrijven in de Power Query M-taal. Zie ook het artikel Power Query-functies en voorbeeldquery's. Voordat u de query's en variabelen gebruikt in Power BI, moet u ze altijd testen met CDF Query Explorer om er zeker van te zijn dat ze correct zijn.

ODataCDF

Gebruik deze functie om gegevens op te halen uit de Cognite OData-services.

Parameter	Type	Beschrijving
url	Tekst	Het URL-pad naar de OData-aanvraag, inclusief de projectnaam. Voorbeelden: "publicdata", "publicdata/Timeseries".
apiVersion	Tekst (optioneel)	De API-versie van de OData-service die voor de aanvraag moet worden gebruikt. Standaard: "v1" De nieuwste versie van de assetgerichte OData-service is "v1". De nieuwste versie voor de OData-gegevensmodelleringsservice is "20230821".

ODataDataModel

Haal gegevens uit een gegevensmodel in CDF op via de OData-gegevensmodelleringsservice.

Parameter	Type	Beschrijving
space	Tekst	De externe ID van de gegevensmodelruimte.
datamodel	Tekst	De externe ID van het gegevensmodel.
version	Tekst	De versie van het gegevensmodel.
apiVersion	Tekst (optioneel)	De API-versie van de OData-service die moet worden gebruikt wanneer de aanvraag wordt gedaan. Standaard: "20230821" De nieuwste versie van de OData-service voor gegevensmodellering is "20230821".