Funções da API REST do Power BI

Este artigo detalha as funções disponíveis da API REST do Power BI.

Beta

As funcionalidades descritas nesta seção estão em fase Beta com clientes selecionados e sujeitas a alterações.

GetCDF

Use esta função para buscar dados de APIs de CDF usando o método HTTP GET. A função realiza a auto-paginação do CDF até que o cursor da solicitação seja esgotado. Para garantir desempenho ideal, consulte a Especificação da API do Cognite para os pontos de extremidade compatíveis com este método HTTP e o tamanho máximo de página suportado para cada ponto de extremidade.

Parâmetro	Tipo	Descrição
url	Texto	O caminho da URL para fazer a solicitação, começando logo após o nome do projeto. Exemplos: "/timeseries", "/assets".

PostCDF

Use esta função para buscar dados das APIs do CDF usando o método HTTP POST. A função realiza a auto-paginação do CDF até que o cursor da solicitação seja esgotado. Para garantir desempenho ideal, consulte a Especificação da API do Cognite para os pontos de extremidade compatíveis com este método HTTP.

Parâmetro	Tipo	Descrição
url	Texto	O caminho da URL para fazer a solicitação, começando logo após o nome do projeto. Exemplos: "/timeseries/list", "/assets/list".
body	Texto	Uma representação em texto do corpo JSON a ser enviado com a solicitação. Exemplos: "{}", "{"limit": 1000}". Quando disponível, defina o parâmetro limit para o valor máximo compatível para o ponto de extremidade. Consulte a Especificação da API do Cognite para o desempenho ideal. Ao chamar esta função com Power BI, a consulta é apresentada como uma área de texto de várias linhas. Não é necessário escapar caracteres de aspas duplas. Se você fornecer um corpo JSON inválido, a função retornará um erro do tipo CogniteConnectorError.

observação

A função PostCDF oferece auto-paginação para solicitações simples que esperam um cursor no nível superior do corpo da solicitação. Para solicitações mais complexas, você precisa escrever uma lógica de paginação personalizada usando a linguagem M do Power Query. Veja o artigo sobre funções do Power Query e consultas de exemplo.

GraphQL

Use esta função para buscar dados de um modelo de dados do CDF usando GraphQL.

Parâmetro	Tipo	Descrição
space	Texto	A ID externa do espaço do modelo de dados.
datamodel	Texto	A ID externa do modelo de dados.
version	Texto	A versão do modelo de dados.
query	Texto	Uma representação textual da consulta do GraphQL a ser enviada ao fazer a solicitação. Inclua after:$cursor and pageInfo { hasNextPage endCursor } na consulta para habilitar a paginação automática. Considere definir o parâmetro first para 1000 (limite máximo compatível) para desempenho ideal. Exemplo: "query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}". Ao invocar essa função no Power BI, a consulta é apresentada como uma área de texto de várias linhas. Você não precisa escapar os caracteres de aspas duplas. Se você fornecer uma consulta do GraphQL inválida, a função retorna um erro do tipo CogniteAPIError.
variables	Texto	Uma representação textual das variáveis de JSON a serem enviadas ao fazer a solicitação. Exemplo: "{""country"": ""Norway""}". Não inclua a variável cursor no parâmetro variables. Isso é gerenciado automaticamente pelo conector. Se você fornecer um corpo JSON inválido, a função retorna um erro do tipo CogniteConnectorError.

observação

A função GraphQL oferece paginação automática para consultas do GraphQL que incluem apenas uma expressão de consulta com um único alvo de paginação, identificado pelos campos after: $cursor e pageInfo { hasNextPage endCursor }. Para consultas mais complexas, é necessário escrever uma lógica de paginação personalizada usando a linguagem M do Power Query. Veja também o artigo de funções do Power Query e consultas de exemplo. Antes de usar as consultas e variáveis em Power BI, sempre teste-as com o CDF Query Explorer para garantir que estão corretas.

ODataCDF

Use esta função para buscar dados do serviços do Cognite OData.

Parâmetro	Tipo	Descrição
url	Texto	O caminho da URL para a solicitação do OData, incluindo o nome do projeto. Exemplos: "publicdata", "publicdata/Timeseries".
apiVersion	Texto (opcional)	A versão da API do serviço do OData a ser utilizada com a solicitação. Padrão: "v1". A versão mais recente do serviço do OData centrado em ativos "v1". Para o serviço de modelagem de dados do OData, a versão mais recente é "20230821".

ODataDataModel

Buscar dados de um modelo de dados no CDF usando o serviço de modelagem de dados do OData.

Parâmetro	Tipo	Descrição
space	Texto	A ID externa do espaço do modelo de dados.
datamodel	Texto	A ID externa do modelo de dados.
version	Texto	A versão do modelo de dados.
apiVersion	Texto (opcional)	A versão da API do serviço do OData a ser utilizada ao fazer a solicitação. Padrão: "20230821". A versão mais recente do serviço do OData de modelagem de dados é "20230821".