Partager via

Items - Execute Query (beta)

Service:
GraphModel
Version d'API:
v1

Exécute une requête sur le modèle de graphe spécifié.

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 .

É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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/executeQuery?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.

Corps de la demande

Nom Obligatoire Type Description
query True

string

Chaîne de requête.

Réponses

Nom Type Description
200 OK

file

L’exécution de la requête s’est terminée avec succès. Les résultats sont au format JSON. Reportez-vous à l’API MSFT GQL pour savoir comment lire les données.
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 :

  • OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

  • CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Execute a graph query example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphModels/5b218778-e7a5-4d73-8187-f10824047715/executeQuery?beta=True

{
  "query": "MATCH (node_station:`station`) RETURN TO_JSON_STRING(node_station) AS `station` LIMIT 10;"
}

Exemple de réponse

Code d’état:
200 
{
  "status": {
    "code": "00000",
    "description": "note: successful completion",
    "diagnostics": {
      "OPERATION": "query",
      "OPERATION_CODE": "0",
      "CURRENT_SCHEMA": "/"
    }
  },
  "result": {
    "kind": "TABLE",
    "columns": [
      {
        "name": "station",
        "gqlType": "STRING",
        "jsonType": "string"
      }
    ],
    "data": [
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263937\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Chancery_Lane\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263938\",\"properties\":{\"stationFrom\":\"Chancery_Lane\",\"stationTo\":\"St_Paul's\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263939\",\"properties\":{\"stationFrom\":\"Hyde_Park_Corner\",\"stationTo\":\"Green_Park\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263940\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Russel_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263941\",\"properties\":{\"stationFrom\":\"Euston\",\"stationTo\":\"Warren_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263942\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"Pimlico\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263943\",\"properties\":{\"stationFrom\":\"London_Bridge\",\"stationTo\":\"Monument\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263944\",\"properties\":{\"stationFrom\":\"Moorgate\",\"stationTo\":\"Old_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263945\",\"properties\":{\"stationFrom\":\"South_Kensington\",\"stationTo\":\"Sloane_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263946\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"St_James's_Park\"}}"
      }
    ]
  }
}

Définitions

Nom Description
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

Exécutez la charge utile de la demande de requête.

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.

ExecuteQueryRequest

Objet

Exécutez la charge utile de la demande de requête.

Nom Type Description
query

string

Chaîne de requête.