Power BI REST API 関数

この記事では、利用可能な Power BI REST API 関数について詳しく説明しています。

ベータ

このセクションで説明されている機能は現在、特定のお客様を対象にベータ テスト中であり、変更される可能性があります。

GetCDF

この関数を使用して、HTTP GET メソッドで CDF API からデータを取得します。関数は、リクエスト カーソルが尽きるまで CDF を自動的にページングします。最適なパフォーマンスを確保するために、この HTTP メソッドをサポートするエンドポイントと、各エンドポイントでサポートされる最大ページ サイズについては、Cognite API 仕様を参照してください。

パラメータ	タイプ	説明
url	テキスト	プロジェクト名の直後から始まる、リクエストを行うための URL パス。例: "/timeseries"、"/assets"。

PostCDF

この関数を使用して、HTTP POST メソッドで CDF API からデータを取得します。関数は、リクエスト カーソルが尽きるまで CDF を自動的にページングします。最適なパフォーマンスを確保するために、この HTTP メソッドをサポートするエンドポイントについては、Cognite API 仕様を参照してください。

パラメータ	タイプ	説明
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""}"。cursor 変数を variables パラメータに含めないでください。コネクタによって自動で管理されます。無効な JSON ボディを提供すると、この関数は CogniteConnectorError タイプのエラーを返します。

注意

GraphQL 関数は、after: $cursor と pageInfo { hasNextPage endCursor } のフィールドで識別される 1 つのクエリ式と 1 つのページング対象のみを含む GraphQL クエリに対して、自動ページングを提供します。より複雑なクエリの場合は、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" です。