Items - Get Queryable Graph Type (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	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getQueryableGraphType?beta={beta}

Параметры URI

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

Ответы

Имя. Тип Описание

200 OK

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

GraphType

Текущий тип графа, допускающий запросы.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

ItemNotFound — запрошенный элемент не найден.

Примеры

Get queryable graph type example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/graphModels/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getQueryableGraphType?beta=True

Пример ответа

Код состояния:: 200

{
  "nodeTypes": [
    {
      "alias": "096a5133-fd82-4000-ac8a-404532ab6fd6",
      "primaryKeyProperties": [
        "customerIDK"
      ],
      "labels": [
        "customer"
      ],
      "properties": [
        {
          "name": "customerIDK",
          "type": "INT"
        },
        {
          "name": "firstName",
          "type": "STRING"
        },
        {
          "name": "lastName",
          "type": "STRING"
        },
        {
          "name": "fullName",
          "type": "STRING"
        }
      ]
    },
    {
      "alias": "dced4642-b93d-4da4-815c-a171932043a4",
      "primaryKeyProperties": [
        "productIDK"
      ],
      "labels": [
        "products"
      ],
      "properties": [
        {
          "name": "productIDK",
          "type": "INT"
        },
        {
          "name": "productNumber",
          "type": "STRING"
        },
        {
          "name": "productName",
          "type": "STRING"
        },
        {
          "name": "modelName",
          "type": "STRING"
        },
        {
          "name": "makeFlag",
          "type": "INT"
        },
        {
          "name": "standardCost",
          "type": "FLOAT"
        },
        {
          "name": "listPrice",
          "type": "FLOAT"
        },
        {
          "name": "subCategoryIDFK",
          "type": "INT"
        }
      ]
    }
  ],
  "edgeTypes": [
    {
      "alias": "3ef6a474-ef38-4923-abcf-6f2e9230f1eb",
      "labels": [
        "customerProducts"
      ],
      "sourceNodeType": {
        "alias": "096a5133-fd82-4000-ac8a-404532ab6fd6"
      },
      "destinationNodeType": {
        "alias": "dced4642-b93d-4da4-815c-a171932043a4"
      },
      "properties": []
    }
  ]
}

Определения

Имя.	Описание
EdgeType	Тип пограничного графа.
ErrorParameter	Структурированный параметр, предоставляющий дополнительный контекст, доступный для чтения компьютера, об ошибке.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GraphType	Тип графа, указывающий структуру графа.
NodeType	Тип узла графа.
NodeTypeReference	Ссылка на тип узла.
Property	Свойство элемента graph.

EdgeType

Объект

Тип пограничного графа.

Имя.	Тип	Описание
alias	string	Псевдоним типа edge.
destinationNodeType	NodeTypeReference	Тип целевого узла.
labels	string[]	Метки типа ребра.
properties	Property[]	Список свойств типа edge.
sourceNodeType	NodeTypeReference	Тип исходного узла.

ErrorParameter

Объект

Структурированный параметр, предоставляющий дополнительный контекст, доступный для чтения компьютера, об ошибке.

Имя.	Тип	Описание
message	string	Читаемое человеком описание значения параметра.
name	string	Идентификатор параметра.
value	string	Значение параметра.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

GraphType

Объект

Тип графа, указывающий структуру графа.

Имя.	Тип	Описание
edgeTypes	EdgeType[]	Список типов ребер графа.
nodeTypes	NodeType[]	Список типов узлов графа.

NodeType

Объект

Тип узла графа.

Имя.	Тип	Описание
alias	string	Псевдоним типа узла.
labels	string[]	Метки типа узла.
primaryKeyProperties	string[]	Список свойств первичного ключа типа узла.
properties	Property[]	Список свойств типа узла.

NodeTypeReference

Объект

Ссылка на тип узла.

Имя.	Тип	Описание
alias	string	Псевдоним типа узла.

Property

Объект

Свойство элемента graph.

Имя.	Тип	Описание
name	string	Имя свойства.
type	string	Тип свойства.