Items - Execute Query (beta)

サービス:: GraphModel

API バージョン:: v1

指定したグラフモデルに対してクエリを実行します。

注

GraphModel 項目は現在プレビュー段階です (詳細については、こちらをご覧ください)。この API はベータリリースの一部であり、評価と開発のみを目的として提供されます。フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。この API を呼び出すとき、呼び出し元はクエリパラメーター trueの値としてbetaを指定する必要があります (previewクエリパラメーターはbetaに置き換えられました。下位互換性のために、previewは引き続きサポートされており、beta) と同じように動作します。

この API では、改ページ位置の修正がサポートされています。

Permissions

呼び出し元には ビューアー ワークスペースロールが必要です。

必要な委任されたスコープ

Workspace.Read.All または Workspace.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	Support
ユーザー	イエス
サービスプリンシパルとマネージド ID	いいえ

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/executeQuery?beta={beta}

URI パラメーター

名前	/	必須	型	説明
GraphModelId	path	True	string (uuid)	GraphModel ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
beta	query	True	boolean	この API にアクセスするには、この必須パラメーターを `true` に設定する必要があります。これは現在ベータ版です。

要求本文

名前	必須	型	説明
query	True	string	クエリ文字列。

応答

名前型説明

200 OK

名前	型	説明
200 OK	file	クエリの実行が正常に完了しました。結果は JSON 形式です。データの読み取り方法については、 MSFT GQL API を参照してください。
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。 CorruptedPayload - 指定されたペイロードが破損しています。

file

クエリの実行が正常に完了しました。結果は JSON 形式です。データの読み取り方法については、 MSFT GQL API を参照してください。

429 Too Many Requests

ErrorResponse

サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。
CorruptedPayload - 指定されたペイロードが破損しています。

例

Execute a graph query example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphModels/5b218778-e7a5-4d73-8187-f10824047715/executeQuery?beta=True

{
  "query": "MATCH (node_station:`station`) RETURN TO_JSON_STRING(node_station) AS `station` LIMIT 10;"
}

応答のサンプル

状態コード:: 200

{
  "status": {
    "code": "00000",
    "description": "note: successful completion",
    "diagnostics": {
      "OPERATION": "query",
      "OPERATION_CODE": "0",
      "CURRENT_SCHEMA": "/"
    }
  },
  "result": {
    "kind": "TABLE",
    "columns": [
      {
        "name": "station",
        "gqlType": "STRING",
        "jsonType": "string"
      }
    ],
    "data": [
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263937\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Chancery_Lane\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263938\",\"properties\":{\"stationFrom\":\"Chancery_Lane\",\"stationTo\":\"St_Paul's\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263939\",\"properties\":{\"stationFrom\":\"Hyde_Park_Corner\",\"stationTo\":\"Green_Park\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263940\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Russel_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263941\",\"properties\":{\"stationFrom\":\"Euston\",\"stationTo\":\"Warren_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263942\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"Pimlico\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263943\",\"properties\":{\"stationFrom\":\"London_Bridge\",\"stationTo\":\"Monument\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263944\",\"properties\":{\"stationFrom\":\"Moorgate\",\"stationTo\":\"Old_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263945\",\"properties\":{\"stationFrom\":\"South_Kensington\",\"stationTo\":\"Sloane_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263946\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"St_James's_Park\"}}"
      }
    ]
  }
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ExecuteQueryRequest	クエリ要求ペイロードを実行します。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

ExecuteQueryRequest

Object

クエリ要求ペイロードを実行します。

名前	型	説明
query	string	クエリ文字列。

次の方法で共有

Items - Execute Query (beta)

Permissions

必要な委任されたスコープ

Microsoft Entra でサポートされている ID

インターフェイス

URI パラメーター

要求本文

応答

例

Execute a graph query example

要求のサンプル

応答のサンプル

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExecuteQueryRequest