Items - Get Queryable Graph Type (beta)

Usługa:

GraphModel

Wersja interfejsu API:

v1

Pobierz bieżący typ grafu z możliwością wykonywania zapytań.

Uwaga / Notatka

Element GraphModel jest obecnie w wersji zapoznawczej (dowiedz się więcej). Ten interfejs API jest częścią wersji beta i jest udostępniany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego. Podczas wywoływania tego interfejsu API wywołujące muszą określić true jako wartość parametru beta zapytania (preview parametr zapytania został zastąpiony przez betaelement . W przypadku zgodności z poprzednimi wersjami nadal jest obsługiwana preview i zachowuje się tak samo jak beta).

Ten interfejs API obsługuje stronicowanie.

Permissions

Obiekt wywołujący musi mieć rolę obszaru roboczego przeglądarki . Obiekt wywołujący musi mieć uprawnienia do odczytu dla modelu grafu.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Microsoft Entra obsługiwane tożsamości

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
graphModelId	path	True	string (uuid)	Identyfikator modelu GraphModel.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
beta	query	True	boolean	Ten wymagany parametr musi być ustawiony, aby uzyskać dostęp do true tego interfejsu API, który jest obecnie w wersji beta.

Odpowiedzi

Nazwisko	Typ	Opis
200 OK	GraphType	Bieżący typ grafu z możliwością wykonywania zapytań.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony.

Przykłady

Get queryable graph type example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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": []
    }
  ]
}

Definicje

Nazwisko	Opis
EdgeType	Typ krawędzi grafu.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
GraphType	Typ grafu, który określa strukturę grafu.
NodeType	Typ węzła grafu.
NodeTypeReference	Odwołanie do typu węzła.
Property	Właściwość elementu grafu.

EdgeType

Objekt

Typ krawędzi grafu.

Nazwisko	Typ	Opis
alias	string	Alias typu krawędzi.
destinationNodeType	NodeTypeReference	Typ węzła docelowego.
labels	string[]	Etykiety typu krawędzi.
properties	Property[]	Lista właściwości typu krawędzi.
sourceNodeType	NodeTypeReference	Typ węzła źródłowego.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GraphType

Objekt

Typ grafu, który określa strukturę grafu.

Nazwisko	Typ	Opis
edgeTypes	EdgeType[]	Lista typów krawędzi grafu.
nodeTypes	NodeType[]	Lista typów węzłów grafu.

NodeType

Objekt

Typ węzła grafu.

Nazwisko	Typ	Opis
alias	string	Alias typu węzła.
labels	string[]	Etykiety typów węzłów.
primaryKeyProperties	string[]	Lista właściwości klucza podstawowego typu węzła.
properties	Property[]	Lista właściwości typu węzła.

NodeTypeReference

Objekt

Odwołanie do typu węzła.

Nazwisko	Typ	Opis
alias	string	Alias typu węzła.

Property

Objekt

Właściwość elementu grafu.

Nazwisko	Typ	Opis
name	string	Nazwa właściwości.
type	string	Typ właściwości.