Delen via


Items - Get Queryable Graph Type (beta)

Haal het huidige querybare grafiektype op.

Opmerking

GraphModel-item is momenteel in preview (meer informatie). Deze API maakt deel uit van een bètaversie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik. Bij het aanroepen van deze API moeten aanroepers opgeven true als de waarde voor de queryparameter beta (preview de queryparameter is vervangen door beta. Voor achterwaartse compatibiliteit preview wordt nog steeds ondersteund en gedraagt zich hetzelfde als beta).

Deze API ondersteunt paginering.

Permissions

De aanroeper moet een werkruimterol voor de kijker hebben. De aanroeper moet leesmachtigingen hebben voor het grafiekmodel.

Vereiste gedelegeerde bereiken

Workspace.Read.All of Workspace.ReadWrite.All

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Support
User Yes
serviceprincipal en beheerde identiteiten Yes

gebruikersinterface

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

URI-parameters

Name In Vereist Type Description
graphModelId
path True

string (uuid)

De GraphModel-id.

workspaceId
path True

string (uuid)

De werkruimte-ID.

beta
query True

boolean

Deze vereiste parameter moet worden ingesteld voor true toegang tot deze API, die momenteel in bèta is.

Antwoorden

Name Type Description
200 OK

GraphType

Het huidige querybare grafiektype.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • ItemNotFound : het aangevraagde item is niet gevonden.

Voorbeelden

Get queryable graph type example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
EdgeType

Een grafiekrandtype.

ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.

ErrorResponse

Het foutbericht.

ErrorResponseDetails

De details van het foutbericht.

GraphType

Het grafiektype dat de structuur van een grafiek aangeeft.

NodeType

Een grafiekknooppunttype.

NodeTypeReference

Een verwijzing naar een knooppunttype.

Property

Een grafiekelementeigenschap.

EdgeType

Een grafiekrandtype.

Name Type Description
alias

string

De edge-typealias.

destinationNodeType

NodeTypeReference

Het doelknooppunttype.

labels

string[]

De randtypelabels.

properties

Property[]

Een lijst met eigenschappen van het edge-type.

sourceNodeType

NodeTypeReference

Het type bronknooppunt.

ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.

resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.

message

string

Een leesbare weergave van de fout.

moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.

relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.

message

string

Een leesbare weergave van de fout.

relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

GraphType

Het grafiektype dat de structuur van een grafiek aangeeft.

Name Type Description
edgeTypes

EdgeType[]

Een lijst met grafiekrandtypen.

nodeTypes

NodeType[]

Een lijst met grafiekknooppunttypen.

NodeType

Een grafiekknooppunttype.

Name Type Description
alias

string

De alias van het knooppunttype.

labels

string[]

Het knooppunttypelabels.

primaryKeyProperties

string[]

Een lijst met primaire sleuteleigenschappen van het knooppunttype.

properties

Property[]

Een lijst met eigenschappen van het knooppunttype.

NodeTypeReference

Een verwijzing naar een knooppunttype.

Name Type Description
alias

string

De alias van het knooppunttype.

Property

Een grafiekelementeigenschap.

Name Type Description
name

string

De naam van de eigenschap.

type

string

Het eigenschapstype.