Funzioni API REST Power BI

Questo articolo descrive in dettaglio le funzioni API REST Power BI disponibili.

Beta

Le funzionalità descritte in questa sezione sono attualmente in beta testing presso alcuni clienti, pertanto sono soggette a modifiche.

GetCDF

Utilizzare questa funzione per recuperare dati dalle API CDF utilizzando il metodo GET HTTP. La funzione esegue l'impaginazione automatica di CDF fino all'esaurimento del cursore della richiesta. Per garantire prestazioni ottimali, vedere le specifiche delle API di Cognite per gli endpoint che supportano questo metodo HTTP e le dimensioni pagina massime supportate per ogni endpoint.

Parametro	Tipo	Descrizione
url	Testo	Il percorso dell'URL per creare la richiesta, con inizio subito dopo il nome del progetto. Esempi: "/timeseries", "/assets".

PostCDF

Utilizzare questa funzione per recuperare dati dalle API CDF utilizzando il metodo POST HTTP. La funzione esegue l'impaginazione automatica di CDF fino all'esaurimento del cursore della richiesta. Per garantire prestazioni ottimali, vedere le specifiche delle API di Cognite per gli endpoint che supportano questo metodo HTTP.

Parametro	Tipo	Descrizione
url	Testo	Il percorso dell'URL per creare la richiesta, con inizio subito dopo il nome del progetto. Esempi: "/timeseries/list", "/assets/list".
body	Testo	Una rappresentazione di testo del corpo JSON da inviare con la richiesta. Esempi: "{}", "{"limit": 1000}". Se disponibile, impostare il parametro limit sul valore supportato massimo per l'endpoint. Per garantire prestazioni ottimali, vedere le specifiche delle API di Cognite. Quando si richiama questa funzione con Power BI, la query viene presentata come un'area di testo multiriga. Non è necessario aggiungere caratteri di escape davanti alle virgolette doppie. Se si fornisce un corpo JSON non valido, la funzione restituirà un errore del tipo CogniteConnectorError.

nota

La funzione PostCDF offre l'impaginazione automatica per richieste semplici che si aspettano un cursore nel livello superiore del corpo della richiesta. Per richieste più complesse, è necessario scrivere una logica di impaginazione personalizzata utilizzando il linguaggio M di Power Query. Vedere l'articolo in Funzioni Power Query e query di esempio.

GraphQL

Utilizzare questa funzione per recuperare dati da un modello di dati CDF utilizzando GraphQL.

Parametro	Tipo	Descrizione
space	Testo	L'ID esterno dello spazio del modello di dati.
datamodel	Testo	L'ID esterno del modello di dati.
version	Testo	La versione del modello di dati.
query	Testo	Una rappresentazione di testo della query GraphQL da inviare quando si crea la richiesta. Includere after:$cursor and pageInfo { hasNextPage endCursor } nella query per abilitare l'impaginazione automatica. Può essere utile impostare il parametro first su 1000 (limite massimo supportato) per ottenere prestazioni ottimali. Esempio: "query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}". Quando si richiama questa funzione con Power BI, la query viene presentata come area di testo multiriga. Non è necessario aggiungere caratteri di escape davanti alle virgolette doppie. Se si fornisce una query GraphQL non valida, la funzione restituisce un errore del tipo CogniteAPIError.
variables	Testo	Una rappresentazione di testo delle variabili JSON da inviare quando si crea la richiesta. Esempio: "{""country"": ""Norway""}". Non includere la variabile cursor nel parametro variables. È gestita automaticamente dal connettore. Se si fornisce un corpo JSON non valido, la funzione restituisce un errore del tipo CogniteConnectorError.

nota

La funzione GraphQL offre l'impaginazione automatica delle query GraphQL che includono solo un'espressione di query con un target di impaginazione, identificato dai campi after: $cursor e pageInfo { hasNextPage endCursor }. Per query più complesse, è necessario scrivere una logica di impaginazione personalizzata utilizzando il linguaggio M di Power Query. Vedere anche l'articolo Funzioni Power Query e query di esempio. Prima di utilizzare le query e le variabili in Power BI, testarle sempre con CDF Query Explorer per assicurarsi che siano corrette.

ODataCDF

Utilizzare questa funzione per recuperare dati dai servizi OData di Cognite.

Parametro	Tipo	Descrizione
url	Testo	Il percorso dell'URL della richiesta OData, incluso il nome del progetto. Esempi: "publicdata", "publicdata/Timeseries".
apiVersion	Testo (facoltativo)	La versione API del servizio OData da utilizzare con la richiesta. Predefinito: "v1". La versione più recente del servizio OData asset-centric è "v1". Per il servizio OData di modellazione dei dati, la versione più recente è "20230821".

ODataDataModel

Recuperare dati da un modello di dati in CDF utilizzando il servizio OData di modellazione dei dati.

Parametro	Tipo	Descrizione
space	Testo	L'ID esterno dello spazio del modello di dati.
datamodel	Testo	L'ID esterno del modello di dati.
version	Testo	La versione del modello di dati.
apiVersion	Testo (facoltativo)	La versione API del servizio OData da utilizzare quando si crea la richiesta. Predefinito: "20230821". La versione più recente del servizio OData di modellazione dei dati è "20230821".