Del via

Items - Get Queryable Graph Type (beta)

Tjeneste:
GraphModel
API-version:
v1

Hent den aktuelle graftype, der kan forespørges på.

Notat

GraphModel-elementet findes i øjeblikket som prøveversion (få mere at vide). Denne API er en del af en betaversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug. Når du kalder denne API, skal kalderne angive true som værdien for forespørgselsparameteren beta (preview forespørgselsparameteren er blevet erstattet af beta. Af hensyn til bagudkompatibilitet preview understøttes stadig og fungerer på samme måde som beta).

Denne API understøtter sideinddeling.

Tilladelser

Den, der ringer op, skal have en seerarbejdsområderolle . Den, der ringer op, skal have læserettigheder til grafmodellen.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Støtte
Bruger Yes
tjenesteprincipal og administrerede identiteter No

Grænseflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
GraphModelId
 path True

string (uuid)

Id'et GraphModel.
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.
beta
 query True

boolean

Denne påkrævede parameter skal angives til for at true få adgang til denne API, som i øjeblikket er i beta.

Svar

Name Type Beskrivelse
200 OK

GraphType

Den aktuelle graftype, der kan forespørges på.
429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • ItemNotFound – Det ønskede element blev ikke fundet.

Eksempler

Get queryable graph type example

Eksempelanmodning

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

Definitioner

Name Beskrivelse
EdgeType

En grafkanttype.
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
GraphType

Den graftype, der angiver strukturen af en graf.
NodeType

En grafnodetype.
NodeTypeReference

En reference til en nodetype.
Property

En grafelementegenskab.

EdgeType

Objekt

En grafkanttype.

Name Type Beskrivelse
alias

string

Aliassen af kanttypen.
destinationNodeType

NodeTypeReference

Destinationsnodens type.
labels

string[]

Kanttypenavne.
properties

Property[]

En liste over egenskaber for kanttyper.
sourceNodeType

NodeTypeReference

Kildenodetypen.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

GraphType

Objekt

Den graftype, der angiver strukturen af en graf.

Name Type Beskrivelse
edgeTypes

EdgeType[]

En liste over grafkanttyper.
nodeTypes

NodeType[]

En liste over grafnodetyper.

NodeType

Objekt

En grafnodetype.

Name Type Beskrivelse
alias

string

Nodetypealiasset.
labels

string[]

Nodetypenavnene.
primaryKeyProperties

string[]

En liste over egenskaber for primær nøgle af nodetypen.
properties

Property[]

En liste over egenskaber for nodetype.

NodeTypeReference

Objekt

En reference til en nodetype.

Name Type Beskrivelse
alias

string

Nodetypealiasset.

Property

Objekt

En grafelementegenskab.

Name Type Beskrivelse
name

string

Egenskabsnavnet.
type

string

Egenskabstypen.