Items - Execute Query (beta)

Služba:

GraphModel

Verzia rozhrania API:

v1

Spustí dotaz v zadanom modeli grafu.

Poznámka

Položka GraphModel je momentálne v režime ukážky (ďalšie informácie). Toto rozhranie API je súčasťou verzie Beta a je určené len na účely hodnotenia a vývoja. Môže sa zmeniť na základe pripomienok a neodporúča sa na použitie v produkčnom prostredí. Pri volaní tohto rozhrania API musia volajúci zadať true ako hodnotu parametra beta dotazu (preview parameter dotazu bol nahradený hodnotou beta. Pre spätnú kompatibilitu preview je však stále podporovaný a správa sa rovnako ako beta).

Toto rozhranie API podporuje stránkovanie.

Povolenia

Volajúci musí mať rolu pracovného priestoru čitateľa .

Povinné delegované rozsahy

Workspace.Read.All alebo Workspace.ReadWrite.All

podporované identity Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
User	Yes
Objekt služby a spravované identity	Yes

Rozhranie

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

Parametre URI

Name	V	Povinné	Typ	Description
graphModelId	path	True	string (uuid)	Id modelu GraphModel.
workspaceId	path	True	string (uuid)	ID pracovného priestoru.
beta	query	True	boolean	Tento povinný parameter musí byť nastavený na prístup k true tomuto API, ktoré je momentálne v beta verzii.

Text požiadavky

Name	Povinné	Typ	Description
query	True	string	Reťazec dotazu.

Odpovede

Name	Typ	Description
200 OK	file	Vykonanie dotazu sa úspešne dokončilo. Výsledky sú vo formáte JSON. Informácie o prečítaní údajov nájdete v rozhraní MSFT GQL API .
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: OperationNotSupportedForItem – Operácia nie je podporovaná pre požadovanú položku. CorruptedPayload – poskytnutá údajová časť je poškodená.

Príklady

Execute a graph query example

Vzorová požiadavka

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

Vzorová odpoveď

Kód stavu:

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

Definície

Name	Description
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
ExecuteQueryRequest	Spustite údajovú časť požiadavky dotazu.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
isRetriable	boolean	Ak je hodnota true, žiadosť sa môže zopakovať. Retry-After Ak je k dispozícii, oneskorenie môžete určiť pomocou hlavičky odpovede.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

ExecuteQueryRequest

Object

Spustite údajovú časť požiadavky dotazu.

Name	Typ	Description
query	string	Reťazec dotazu.