Funciones de la API REST de Power BI

Este artículo detalla las funciones disponibles en la API REST Power BI.

Beta

Las funciones descritas en esta sección se encuentran actualmente en pruebas beta con clientes seleccionados y están sujetas a cambios.

GetCDF

Use esta función para obtener datos de las API CDF mediante el método HTTP GET. La función pagina automáticamente CDF hasta que se agote el cursor de solicitud. Para garantizar un rendimiento óptimo, consulte la especificación de la API de Cognite para conocer los puntos de conexión que admiten este método HTTP y el tamaño máximo de página admitido para cada punto de conexión.

Parámetro	Tipo	Descripción
url	Texto	La ruta de la URL para realizar la solicitud, que comienza justo después del nombre del proyecto. Ejemplos: "/timeseries", "/assets".

PostCDF

Use esta función para obtener datos de las API de CDF mediante el método HTTP POST. La función pagina automáticamente CDF hasta que se agote el cursor de solicitud. Para garantizar un rendimiento óptimo, consulte la especificación de la API de Cognite para conocer los puntos de conexión que admiten este método HTTP.

Parámetro	Tipo	Descripción
url	Texto	La ruta de la URL para realizar la solicitud, que comienza justo después del nombre del proyecto. Ejemplos: "/timeseries/list", "/assets/list".
body	Texto	Una representación textual del cuerpo JSON que se enviará con la solicitud. Ejemplos: "{}", "{"limit": 1000}". Cuando esté disponible, configure el parámetro limit con el valor máximo admitido para el punto de conexión. Consulte la especificación de la API de Cognite para lograr el rendimiento óptimo. Al invocar esta función con Power BI, la consulta se presenta como un área de texto de varias líneas. No es necesario que escape los caracteres de comillas dobles. Si proporciona un cuerpo JSON no válido, la función devolverá un error de tipo CogniteConnectorError.

nota

La función PostCDF ofrece paginación automática en el caso de solicitudes simples que esperan un cursor en el nivel superior del cuerpo de la solicitud. En el caso de solicitudes más complejas, debe escribir una lógica de paginación personalizada utilizando el lenguaje M de Power Query. Consulte el artículo sobre Funciones de Power Query y consultas de ejemplo.

GraphQL

Use esta función para obtener datos de un modelo de datos CDF mediante GraphQL.

Parámetro	Tipo	Descripción
space	Texto	La ID externa del espacio del modelo de datos.
datamodel	Texto	La ID externa del modelo de datos.
version	Texto	La versión del modelo de datos.
query	Texto	Una representación de texto de la consulta GraphQL que se enviará con la solicitud. Incluya after:$cursor and pageInfo { hasNextPage endCursor } en la consulta para habilitar la paginación automática. Considere configurar el parámetro first en 1000 (límite máximo admitido) para obtener un rendimiento óptimo. Ejemplo: "query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}" Al invocar esta función con Power BI, la consulta se presenta como un área de texto de varias líneas. No es necesario que escape los caracteres de comillas dobles. Si proporciona un GraphQL no válido, la función devolverá un error de tipo CogniteAPIError.
variables	Texto	Una representación de texto de las variables JSON que se enviará con la solicitud. Ejemplo: "{""country"": ""Norway""}" No incluya la variable cursor en el parámetro variables. El conector la administra automáticamente. Si proporciona un cuerpo JSON no válido, la función devolverá un error de tipo CogniteConnectorError.

nota

La función GraphQL ofrece paginación automática para consultas GraphQL que incluyen solo una expresión de consulta con un objetivo de paginación, identificado por los campos after: $cursor y pageInfo { hasNextPage endCursor }. Si se trata de consultas más complejas, debe escribir una lógica de paginación personalizada utilizando el lenguaje M de Power Query. Consulte también el artículo Funciones de Power Query y consultas de ejemplo. Antes de usar las consultas y las variables en Power BI, pruébelas siempre con CDF Query Explorer para asegurarse de que sean correctas.

ODataCDF

Use esta función para obtener datos de los servicios OData de Cognite.

Parámetro	Tipo	Descripción
url	Texto	La ruta de la URL para realizar la solicitud OData, que incluye el nombre del proyecto. Ejemplos: "publicdata", "publicdata/Timeseries".
apiVersion	Texto (opcional)	La versión de la API del servicio OData que se usará con la solicitud. Predeterminado: "v1". La última versión del servicio OData centrado en activos es "v1". Para el servicio de modelado de datos OData, la última versión es "20230821".

ODataDataModel

Obtenga datos de un modelo de datos en CDF mediante el servicio de modelado de datos OData.

Parámetro	Tipo	Descripción
space	Texto	La ID externa del espacio del modelo de datos.
datamodel	Texto	La ID externa del modelo de datos.
version	Texto	La versión del modelo de datos.
apiVersion	Texto (opcional)	La versión de la API del servicio OData que se usará al realizar la solicitud. Predeterminado: "20230821". La última versión del servicio OData de modelado de datos es "20230821".