Items - Get Queryable Graph Type (beta)

Dienst:

GraphModel

API-Version:

v1

Rufen Sie den aktuellen abfragbaren Diagrammtyp ab.

Hinweis

Das GraphModel-Element befindet sich derzeit in der Vorschau (weitere Informationen). Diese API ist Teil einer Betaversion und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen. Beim Aufrufen dieser API müssen Aufrufer den Wert für den Abfrageparameter angeben true (beta Der Abfrageparameter preview wurde durch betaersetzt. Aus Gründen der Abwärtskompatibilität preview wird weiterhin unterstützt und verhält sich wie beta).

Diese API unterstützt Paginierung.

Erlaubnisse

Der Aufrufer muss über eine Rolle des Viewer-Arbeitsbereichs verfügen. Der Aufrufer muss über Leseberechtigungen für das Diagrammmodell verfügen.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Support
Benutzer	Yes
Service Principal und Verwaltete Identitäten	Nein

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
GraphModelId	path	True	string (uuid)	Die GraphModel-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
beta	query	True	boolean	Dieser erforderliche Parameter muss für den Zugriff auf diese API festgelegt true werden, die sich derzeit in der Betaversion befindet.

Antworten

Name	Typ	Beschreibung
200 OK	GraphType	Der aktuelle abfragbare Diagrammtyp.
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: ItemNotFound – Das angeforderte Element wurde nicht gefunden.

Beispiele

Get queryable graph type example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
EdgeType	Ein Graph-Randtyp.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GraphType	Der Diagrammtyp, der die Struktur eines Diagramms angibt.
NodeType	Ein Diagrammknotentyp.
NodeTypeReference	Ein Verweis auf einen Knotentyp.
Property	Eine Graph-Elementeigenschaft.

EdgeType

Objekt

Ein Graph-Randtyp.

Name	Typ	Beschreibung
alias	string	Der Edgetypalias.
destinationNodeType	NodeTypeReference	Der Zielknotentyp.
labels	string[]	Die Randtypbeschriftungen.
properties	Property[]	Eine Liste der Edgetypeigenschaften.
sourceNodeType	NodeTypeReference	Der Quellknotentyp.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GraphType

Objekt

Der Diagrammtyp, der die Struktur eines Diagramms angibt.

Name	Typ	Beschreibung
edgeTypes	EdgeType[]	Eine Liste der Graph-Randtypen.
nodeTypes	NodeType[]	Eine Liste der Diagrammknotentypen.

NodeType

Objekt

Ein Diagrammknotentyp.

Name	Typ	Beschreibung
alias	string	Der Knotentypalias.
labels	string[]	Die Knotentypbeschriftungen.
primaryKeyProperties	string[]	Eine Liste der Primärschlüsseleigenschaften des Knotentyps.
properties	Property[]	Eine Liste der Knotentypeigenschaften.

NodeTypeReference

Objekt

Ein Verweis auf einen Knotentyp.

Name	Typ	Beschreibung
alias	string	Der Knotentypalias.

Property

Objekt

Eine Graph-Elementeigenschaft.

Name	Typ	Beschreibung
name	string	Der Eigenschaftsname.
type	string	Der Eigenschaftentyp.