Items - Get Queryable Graph Type (beta)

Servizio:

GraphModel

Versione API:

v1

Ottenere il tipo di grafo queryable corrente.

Annotazioni

L'elemento GraphModel è attualmente disponibile in anteprima (altre informazioni). Questa API fa parte di una versione beta e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione. Quando si chiama questa API, i chiamanti devono specificare true come valore per il parametro beta di query (preview il parametro di query è stato sostituito da beta. Per la compatibilità con le versioni precedenti, preview è ancora supportato e si comporta allo stesso modo di beta.

Questa API supporta paginazione.

Permissions

Il chiamante deve avere un ruolo dell'area di lavoro visualizzatore . Il chiamante deve disporre delle autorizzazioni di lettura per il modello a grafo.

Ambiti delegati obbligatori

Workspace.Read.All o Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	NO

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
GraphModelId	path	True	string (uuid)	ID GraphModel.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
beta	query	True	boolean	Questo parametro obbligatorio deve essere impostato su per accedere a true questa API, attualmente in versione beta.

Risposte

Nome	Tipo	Descrizione
200 OK	GraphType	Tipo di grafo queryable corrente.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: ItemNotFound: l'elemento richiesto non è stato trovato.

Esempio

Get queryable graph type example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
EdgeType	Tipo di arco del grafo.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GraphType	Tipo di grafo che specifica la struttura di un grafico.
NodeType	Tipo di nodo del grafo.
NodeTypeReference	Riferimento a un tipo di nodo.
Property	Proprietà dell'elemento del grafo.

EdgeType

Oggetto

Tipo di arco del grafo.

Nome	Tipo	Descrizione
alias	string	Alias del tipo di arco.
destinationNodeType	NodeTypeReference	Tipo di nodo di destinazione.
labels	string[]	Etichette dei tipi di arco.
properties	Property[]	Elenco di proprietà del tipo di arco.
sourceNodeType	NodeTypeReference	Tipo di nodo di origine.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GraphType

Oggetto

Tipo di grafo che specifica la struttura di un grafico.

Nome	Tipo	Descrizione
edgeTypes	EdgeType[]	Elenco dei tipi di bordi del grafo.
nodeTypes	NodeType[]	Elenco dei tipi di nodo del grafo.

NodeType

Oggetto

Tipo di nodo del grafo.

Nome	Tipo	Descrizione
alias	string	Alias del tipo di nodo.
labels	string[]	Etichette dei tipi di nodo.
primaryKeyProperties	string[]	Elenco delle proprietà della chiave primaria di tipo nodo.
properties	Property[]	Elenco di proprietà del tipo di nodo.

NodeTypeReference

Oggetto

Riferimento a un tipo di nodo.

Nome	Tipo	Descrizione
alias	string	Alias del tipo di nodo.

Property

Oggetto

Proprietà dell'elemento del grafo.

Nome	Tipo	Descrizione
name	string	Nome della proprietà.
type	string	Tipo di proprietà.