Jaa

Items - Execute Query (beta)

Palvelu:
GraphModel
Ohjelmointirajapinnan versio:
v1

Suorittaa kyselyn määritetyssä kaaviomallissa.

Note

GraphModel-kohde on tällä hetkellä esikatselussa (lisätietoja). Tämä ohjelmointirajapinta on osa beetaversiota, ja se on saatavilla vain arviointi- ja kehitystarkoituksiin. Muutos saattaa perustua palautteeseen, eikä sitä suositella tuotantokäyttöön. Kun kutsut tätä ohjelmointirajapintaa, kutsujien on määritettävä true kyselyparametrin beta arvoksi (preview kyselyparametri on korvattu kohteella beta. Yhteensopivuutta aiempien versioiden kanssa preview tuetaan edelleen, ja se toimii samalla tavalla kuin beta).

Tämä ohjelmointirajapinta tukee sivutuksen.

Oikeudet

Soittajalla on oltava katselijan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.Read.All tai Workspace.ReadWrite.All

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti Tuki
Käyttäjä Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kyllä

Liittymä

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Description
graphModelId
 path True

string (uuid)

GraphModel-tunnus.
workspaceId
 path True

string (uuid)

Työtilan tunnus.
beta
 query True

boolean

Tämä pakollinen parametri on määritettävä, jotta true voit käyttää tätä ohjelmointirajapintaa, joka on tällä hetkellä beetaversiossa.

Pyynnön leipäteksti

Nimi Pakollinen Tyyppi Description
query True

string

Kyselymerkkijono.

Vastaukset

Nimi Tyyppi Description
200 OK

file

Kyselyn suorittaminen onnistui. Tulokset ovat JSON-muodossa. Katso MSFT GQL -ohjelmointirajapinnasta , miten tietoja luetaan.
429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle.

  • VioittunutPayload – Annetut tiedot ovat vioittuneet.

Esimerkit

Execute a graph query example

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi Description
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
ExecuteQueryRequest

Suorita kyselypyynnön tiedot.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

ExecuteQueryRequest

Kohde

Suorita kyselypyynnön tiedot.

Nimi Tyyppi Description
query

string

Kyselymerkkijono.