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

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	нет

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
GraphModelId	path	True	string (uuid)	Идентификатор GraphModel.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
beta	query	True	boolean	Этот обязательный параметр должен быть установлен для true доступа к этому API, который в настоящее время находится в бета-версии.

Текст запроса

Имя	Обязательно	Тип	Описание
query	True	string	Строка запроса.

Ответы

Имя	Тип	Описание
200 OK	file	Выполнение запроса выполнено успешно. Результаты приведены в формате JSON. Сведения о том, как считывать данные, см. в API GQL MSFT .
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента. Поврежденный Payload — предоставленные полезные данные повреждены.

Примеры

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

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

ExecuteQueryRequest

Объект

Выполнение полезных данных запроса запроса.

Имя	Тип	Описание
query	string	Строка запроса.