Power BI REST API 函数

本文详细介绍了可用的 Power BI REST API 函数。

公开测试

本部分中所述的功能目前在 Beta 测试中面向所选客户提供，可能会更改。

GetCDF

使用此函数可通过 HTTP GET 方法从 CDF API 获取数据。该函数会自动对 CDF 进行分页，直至请求游标耗尽。为了确保达到最佳性能，请参阅 Cognite API 规范，了解支持此 HTTP 方法的端点以及每个端点支持的最大页面大小。

参数	Type	Description
url	文本	发出请求的 URL 路径，紧跟在项目名称之后。示例："/timeseries"、"/assets"。

PostCDF

使用此函数可通过 HTTP POST 方法从 CDF API 获取数据。该函数会自动对 CDF 进行分页，直至请求游标耗尽。为了确保达到最佳性能，请参阅 Cognite API 规范，了解支持此 HTTP 方法的端点。

参数	Type	Description
url	文本	发出请求的 URL 路径，紧跟在项目名称之后。示例："/timeseries/list"、"/assets/list"。
body	文本	与请求一起发送的 JSON 正文的文本表示形式。示例："{}"、"{"limit": 1000}"。如果可用，请将 limit 参数设置为端点支持的最大值。请参阅 Cognite API 规范，以确保达到最佳性能。使用 Power BI 调用此函数时，查询将显示为多行文本区域。无需转义双引号字符。如果你提供的 JSON 正文无效，则该函数将返回 CogniteConnectorError 类型的错误。

注意

PostCDF 函数为需要将光标放在请求正文顶层的简单请求提供自动分页功能。对于更复杂的请求，需要使用 Power Query M 语言编写自定义分页逻辑。请参阅有关 Power Query 函数和示例查询的文章。

GraphQL

使用此函数可通过 GraphQL 从 CDF 数据模型获取数据。

参数	类型	描述
space	文本	数据模型空间的外部 ID。
datamodel	文本	数据模型的外部 ID。
version	文本	数据模型的版本。
query	文本	发出请求时要发送的 GraphQL 查询的文本表示形式。在查询中包含 after:$cursor and pageInfo { hasNextPage endCursor }，以启用自动分页。考虑将 first 参数设置为 1000（支持的最大限制），以获得最佳性能。示例："query MyQuery($cursor: String) { listMovies(first: 1000, after: $cursor) { items { name } pageInfo { endCursor hasNextPage }}}"。使用 Power BI 调用此函数时，查询将显示为多行文本区域。无需转义双引号字符。如果你提供的 GraphQL 查询无效，则该函数将返回 CogniteAPIError 类型的错误。
variables	文本	发出请求时要发送的 JSON 变量的文本表示形式。示例："{""country"": ""Norway""}"。请勿在 variables 参数中包含 cursor 变量。它由连接器自动管理。如果你提供的 JSON 正文无效，则该函数将返回 CogniteConnectorError 类型的错误。

注意

GraphQL 函数为仅包含一个查询表达式和一个分页目标的 GraphQL 查询提供自动分页功能，通过 after: $cursor 和 pageInfo { hasNextPage endCursor } 字段标识该函数。对于更复杂的查询，需要使用 Power Query M 语言编写自定义分页逻辑。另请参阅 Power Query 函数和示例查询文章。在 Power BI 中使用查询和变量之前，请务必使用 CDF Query Explorer 对其进行测试，以确保正确无误。

ODataCDF

使用此函数可从 Cognite OData 服务 获取数据。

参数	类型	描述
url	文本	OData 请求的 URL 路径，包括项目名称。示例："publicdata"、"publicdata/Timeseries"。
apiVersion	文本（可选）	发出请求时要使用的 OData 服务的 API 版本。默认："v1"。Asset-centric OData 服务的最新版本为 "v1"。对于数据建模 OData 服务，最新版本为 "20230821"。

ODataDataModel

使用数据建模 OData 服务从 CDF 中的数据模型获取数据。

参数	类型	描述
space	文本	数据模型空间的外部 ID。
datamodel	文本	数据模型的外部 ID。
version	文本	数据模型的版本。
apiVersion	文本（可选）	发出请求时要使用的 OData 服务的 API 版本。默认："20230821"。数据建模 OData 服务的最新版本为 "20230821"。