Items - Get Queryable Graph Type (beta)

Tjänst:

GraphModel

API-version:

v1

Hämta den aktuella frågebara graftypen.

Anmärkning

GraphModel-objektet finns för närvarande i förhandsversion (läs mer). Det här API:et är en del av en betaversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning. När du anropar det här API:et måste anropare ange true som värde för frågeparametern beta (preview frågeparametern har ersatts av beta. För bakåtkompatibilitet preview stöds fortfarande och fungerar på samma sätt som beta).

Det här API:et stöder sidnumrering.

Permissions

Anroparen måste ha en arbetsyteroll för visningsprogrammet . Anroparen måste ha läsbehörighet för grafmodellen.

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
graphModelId	path	True	string (uuid)	GraphModel-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
beta	query	True	boolean	Den här obligatoriska parametern måste anges för att få åtkomst till true det här API:et, som för närvarande är i betaversion.

Svar

Name	Typ	Description
200 OK	GraphType	Den aktuella frågebara graftypen.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte.

Exempel

Get queryable graph type example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
EdgeType	En grafkanttyp.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GraphType	Den graftyp som anger strukturen för ett diagram.
NodeType	En grafnodtyp.
NodeTypeReference	En referens till en nodtyp.
Property	En egenskap för grafelement.

EdgeType

Objekt

En grafkanttyp.

Name	Typ	Description
alias	string	Alias för kanttyp.
destinationNodeType	NodeTypeReference	Målnodtypen.
labels	string[]	Etiketterna för kanttyp.
properties	Property[]	En lista med egenskaper för kanttyp.
sourceNodeType	NodeTypeReference	Källnodtypen.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GraphType

Objekt

Den graftyp som anger strukturen för ett diagram.

Name	Typ	Description
edgeTypes	EdgeType[]	En lista över grafkanttyper.
nodeTypes	NodeType[]	En lista över diagramnodtyper.

NodeType

Objekt

En grafnodtyp.

Name	Typ	Description
alias	string	Alias för nodtyp.
labels	string[]	Nodtypetiketterna.
primaryKeyProperties	string[]	En lista över egenskaper för primärnyckel av nodtyp.
properties	Property[]	En lista över egenskaper för nodtyp.

NodeTypeReference

Objekt

En referens till en nodtyp.

Name	Typ	Description
alias	string	Alias för nodtyp.

Property

Objekt

En egenskap för grafelement.

Name	Typ	Description
name	string	Egenskapsnamnet.
type	string	Egenskapstypen.