Items - Execute Query (beta)

Služba:

GraphModel

Verze rozhraní API:

v1

Spustí dotaz na zadaný grafový model.

Poznámka:

Položka GraphModel je aktuálně ve verzi Preview (další informace). Toto rozhraní API je součástí beta verze a poskytuje se pouze pro účely vyhodnocení a vývoje. Může se změnit na základě zpětné vazby a nedoporučuje se pro produkční použití. Při volání tohoto rozhraní API musí volající zadat true hodnotu parametru beta dotazu (preview parametr dotazu byl nahrazen parametrem betadotazu . Kvůli zpětné kompatibilitě preview se stále podporuje a chová se stejně jako beta).

Toto rozhraní API podporuje stránkování.

Povolení

Volající musí mít roli pracovního prostoru prohlížeče .

Požadované delegovaná rozsahy

Workspace.Read.All nebo Workspace.ReadWrite.All

Microsoft Entra podporované identity

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Support
Uživatel	Ano
Hlavní služba a Spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
graphModelId	path	True	string (uuid)	ID objektu GraphModel.
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.
beta	query	True	boolean	Tento povinný parametr musí být nastavený tak, aby true měl přístup k tomuto rozhraní API, který je aktuálně v beta verzi.

Text požadavku

Name	Vyžadováno	Typ	Description
query	True	string	Řetězec dotazu.

Odpovědi

Name	Typ	Description
200 OK	file	Provádění dotazu bylo úspěšně dokončeno. Výsledky jsou ve formátu JSON. Informace o tom, jak číst data, najdete v rozhraní API GQL MSFT .
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: OperationNotSupportedForItem – Operace není podporována pro požadovanou položku. Poškozená částPayload – zadanou datovou část je poškozena.

Příklady

Execute a graph query example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ExecuteQueryRequest	Spusťte datovou část požadavku dotazu.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

ExecuteQueryRequest

Objekt

Spusťte datovou část požadavku dotazu.

Name	Typ	Description
query	string	Řetězec dotazu.