Power BI REST API-funktioner

I den här artikeln beskrivs tillgängliga Power BI REST API-funktioner i detalj.

Beta

De funktioner som beskrivs i det här avsnittet beta-testas för närvarande av utvalda kunder och kan komma att ändras.

GetCDF

Använd den här funktionen för att hämta data från CDF API:er med hjälp av HTTP GET-metoden. Funktionen paginerar CDF automatiskt tills inget kvarstår att paginera. För att säkerställa optimal prestanda se Cognite API-specifikationen för slutpunkter som stöder den här HTTP-metoden och maxstorleken för sidor för varje slutpunkt.

Parameter	Typ	Beskrivning
url	Text	URL:n för att göra en förfrågan med början direkt efter projektnamnet. Exempel: "/timeseries", "/assets".

PostCDF

Använd den här funktionen för att hämta data från CDF API:er med hjälp av HTTP POST-metoden. Funktionen paginerar CDF automatiskt tills inget kvarstår att paginera. För att säkerställa optimal prestanda se Cognite API-specifikationen för slutpunkter som stöder den här HTTP-metoden.

Parameter	Typ	Beskrivning
url	Text	URL:n för att göra en förfrågan med början direkt efter projektnamnet. Exempel: "/timeseries/list", "/assets/list".
body	Text	En textrepresentation av JSON-data som ska skickas med förfrågan. Exempel: "{}", "{"limit": 1000}". När tillgängligt ställer du in limit-parametern till det maxvärde som stöds för slutpunkten. Se Cognite API-specifikationen för optimal prestanda. När den här funktionen anropas med Power BI, presenteras frågan som ett textområde med flera rader. Du behöver inte använda dubbla citattecken. Om du anger ogiltiga JSON-data returnerar funktionen ett fel av typen CogniteConnectorError.

obs!

PostCDF-funktionen möjliggör autopaginering för enkla förfrågningar som förutsätter en markör på översta nivån av förfrågningsdata. För mer komplexa förfrågningar måste du använda Power Query M-språket för att skriva en anpassad pagineringslogik. Se artikeln om Power Query-funktioner och exempelfrågor.

GraphQL

Använd den här funktionen för att hämta data från en CDF- datamodell med hjälp av GraphQL.

Parameter	Typ	Beskrivning
space	Text	Det externa ID:t för datamodellens utrymme.
datamodel	Text	Datamodellens externa ID.
version	Text	Datamodellens version.
query	Text	En textrepresentation av GraphQL-frågan att skicka när du gör förfrågan. Inkludera after:$cursor and pageInfo { hasNextPage endCursor } i frågan för att aktivera autopaginering. Tänk på att ställa in first-parametern till 1000 (maxgräns som stöds) för optimal prestanda. Exempel: "query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}". När den här funktionen anropas med Power BI, presenteras frågan som ett textområde med flera rader. Du behöver inte använda dubbla citattecken. Om du anger en ogiltig GraphQL-fråga, returnerar funktionen ett fel av typen CogniteAPIError.
variables	Text	En textrepresentation av JSON-variablerna att skicka när du gör förfrågan. Exempel: "{""country"": ""Norway""}". Inkludera inte cursor-variabeln i variables-parametern. Detta hanteras automatiskt av kontakten. Om du anger ogiltiga JSON-data, returnerar funktionen ett fel av typen CogniteConnectorError.

obs!

GraphQL-funktionen innehåller autopaginering för GraphQL-frågor som bara inkluderar ett frågeuttryck med ett pagineringsmål som identifieras av fälten after: $cursor och pageInfo { hasNextPage endCursor }. För mer komplexa frågor måste du använda Power Query M-språket för att skriva en anpassad pagineringslogik. Se även artikeln om Power Query-funktioner och exempelfrågor. Innan du använder frågorna och variabler i Power BI, ska du alltid testa dem med CDF Query Explorer för att säkerställa att de är korrekta.

ODataCDF

Använd den här funktionen för att hämta data från Cognite OData-tjänsterna.

Parameter	Typ	Beskrivning
url	Text	URL:en till OData-förfrågan inklusive projektnamnet. Exempel: "publicdata", "publicdata/Timeseries".
apiVersion	Text (valfritt)	API-versionen av OData-tjänsten att använda med förfrågan. Standard: "v1". Den senaste versionen av asset-centric OData Service är "v1". För OData-tjänsten för datamodellering är den senaste versionen "20230821".

ODataDataModel

Hämta data från en datamodell i CDF med OData-tjänsten för datamodellering.

Parameter	Typ	Beskrivning
space	Text	Det externa ID:t för datamodellens utrymme.
datamodel	Text	Datamodellens externa ID.
version	Text	Datamodellens version.
apiVersion	Text (valfritt)	API-versionen av OData Service att använda när du gör förfrågan. Standard: "20230821". Den senaste versionen av OData Service för datamodellering är "20230821".