Partager via

Items - Get Queryable Graph Type (beta)

Service:
GraphModel
Version d'API:
v1

Obtenez le type de graphique interrogeable actuel.

Note

L’élément GraphModel est actuellement en préversion (en savoir plus). Cette API fait partie d’une version bêta et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production. Lors de l’appel de cette API, les appelants doivent spécifier true comme valeur pour le paramètre beta de requête (preview le paramètre de requête a été remplacé par beta. Pour la compatibilité descendante, preview il est toujours pris en charge et se comporte de la même façon que beta).

Cette API prend en charge pagination.

Permissions

L’appelant doit avoir un rôle d’espace de travail de visionneuse . L’appelant doit disposer d’autorisations de lecture pour le modèle de graphique.

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Microsoft Entra identités prises en charge

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Support
Utilisateur Oui
Service principal et identités gérées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
graphModelId
 path True

string (uuid)

ID GraphModel.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.
beta
 query True

boolean

Ce paramètre obligatoire doit être défini pour accéder à true cette API, qui est actuellement en version bêta.

Réponses

Nom Type Description
200 OK

GraphType

Type de graphique interrogeable actuel.
429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • ItemNotFound : l’élément demandé n’a pas été trouvé.

Exemples

Get queryable graph type example

Exemple de requête

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

Exemple de réponse

Code d’état:
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": []
    }
  ]
}

Définitions

Nom Description
EdgeType

Type d’arête de graphique.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
GraphType

Type de graphique qui spécifie la structure d’un graphique.
NodeType

Type de nœud de graphe.
NodeTypeReference

Référence à un type de nœud.
Property

Propriété d’élément de graphe.

EdgeType

Objet

Type d’arête de graphique.

Nom Type Description
alias

string

Alias de type de périphérie.
destinationNodeType

NodeTypeReference

Type de nœud cible.
labels

string[]

Étiquettes de type de bord.
properties

Property[]

Liste des propriétés de type de périphérie.
sourceNodeType

NodeTypeReference

Type de nœud source.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string (uuid)

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

GraphType

Objet

Type de graphique qui spécifie la structure d’un graphique.

Nom Type Description
edgeTypes

EdgeType[]

Liste des types de bords de graphe.
nodeTypes

NodeType[]

Liste des types de nœuds de graphe.

NodeType

Objet

Type de nœud de graphe.

Nom Type Description
alias

string

Alias de type de nœud.
labels

string[]

Étiquettes de type de nœud.
primaryKeyProperties

string[]

Liste des propriétés de clé primaire de type de nœud.
properties

Property[]

Liste des propriétés de type de nœud.

NodeTypeReference

Objet

Référence à un type de nœud.

Nom Type Description
alias

string

Alias de type de nœud.

Property

Objet

Propriété d’élément de graphe.

Nom Type Description
name

string

Nom de la propriété.
type

string

Type de propriété.