Items - Get Queryable Graph Type (beta)

Tjeneste:: GraphModel

API-versjon:: v1

Hent den gjeldende graftypen som kan spørres.

Note

GraphModel-elementet er for øyeblikket i forhåndsvisning (finn ut mer). Denne API-en er en del av en betaversjon og leveres bare for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk. Når du kaller opp denne API-en, må innringere angi true som verdi for spørringsparameteren beta (preview spørringsparameteren er erstattet av beta. For bakoverkompatibilitet støttes preview fortsatt og fungerer på samme måte som beta).

Denne API-en støtter paginering.

Tillatelser

Innringeren må ha en visningsområderolle. Innringeren må ha lesetillatelser for grafmodellen.

Nødvendige delegerte omfang

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
graphModelId	path	True	string (uuid)	GraphModel-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
beta	query	True	boolean	Denne nødvendige parameteren må angis for å få tilgang til `true` denne API-en, som for øyeblikket er i betaversjon.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	GraphType	Gjeldende graftype som kan spørres.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: ItemNotFound – Finner ikke det forespurte elementet.

GraphType

Gjeldende graftype som kan spørres.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

ItemNotFound – Finner ikke det forespurte elementet.

Eksempler

Get queryable graph type example

Eksempelforespørsel

HTTP

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

Eksempelsvar

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

Definisjoner

Name	Beskrivelse
EdgeType	En grafkanttype.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
GraphType	Graftypen som angir strukturen til en graf.
NodeType	En grafnodetype.
NodeTypeReference	En referanse til en nodetype.
Property	En diagramelementegenskap.

EdgeType

Objekt

En grafkanttype.

Name	Type	Beskrivelse
alias	string	Kanttypealiaset.
destinationNodeType	NodeTypeReference	Målnodetypen.
labels	string[]	Kanttypeetikettene.
properties	Property[]	En liste over egenskaper for kanttype.
sourceNodeType	NodeTypeReference	Kildenodetypen.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

GraphType

Objekt

Graftypen som angir strukturen til en graf.

Name	Type	Beskrivelse
edgeTypes	EdgeType[]	En liste over diagramkanttyper.
nodeTypes	NodeType[]	En liste over diagramnodetyper.

NodeType

Objekt

En grafnodetype.

Name	Type	Beskrivelse
alias	string	Aliaset for nodetype.
labels	string[]	Nodetypeetikettene.
primaryKeyProperties	string[]	En liste over primærnøkkelegenskaper for nodetype.
properties	Property[]	En liste over egenskaper for nodetype.

NodeTypeReference

Objekt

En referanse til en nodetype.

Name	Type	Beskrivelse
alias	string	Aliaset for nodetype.

Property

Objekt

En diagramelementegenskap.

Name	Type	Beskrivelse
name	string	Egenskapsnavnet.
type	string	Egenskapstypen.