Items - Execute Query (beta)

Tjänst:

GraphModel

API-version:

v1

Kör en fråga på den angivna grafmodellen.

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 .

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

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

Begärandetext

Name	Obligatorisk	Typ	Description
query	True	string	Frågesträngen.

Svar

Name	Typ	Description
200 OK	file	Frågekörningen har slutförts. Resultaten är i JSON-format. Läs MSFT GQL-API :et om hur du läser data.
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: OperationNotSupportedForItem – Åtgärden stöds inte för det begärda objektet. CorruptedPayload – den angivna nyttolasten är skadad.

Exempel

Execute a graph query example

Exempelbegäran

HTTP

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;"
}

Exempelsvar

Statuskod:

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\"}}"
      }
    ]
  }
}

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ExecuteQueryRequest	Kör nyttolasten för frågebegäran.

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.

ExecuteQueryRequest

Objekt

Kör nyttolasten för frågebegäran.

Name	Typ	Description
query	string	Frågesträngen.