Items - Get Queryable Graph Type (beta)

Služba:

GraphModel

Verzia rozhrania API:

v1

Získanie aktuálneho dotazovateľného typu 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 . Volajúci musí mať povolenia na čítanie pre model grafu.

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

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

Odpovede

Name	Typ	Description
200 OK	GraphType	Aktuálny dotazovateľný typ grafu.
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: ItemNotFound – požadovaná položka sa nenašla.

Príklady

Get queryable graph type example

Vzorová požiadavka

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/graphModels/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getQueryableGraphType?beta=True

Vzorová odpoveď

Kód stavu:

200

{
  "nodeTypes": [
    {
      "alias": "096a5133-fd82-4000-ac8a-404532ab6fd6",
      "primaryKeyProperties": [
        "customerIDK"
      ],
      "labels": [
        "customer"
      ],
      "properties": [
        {
          "name": "customerIDK",
          "type": "INT"
        },
        {
          "name": "firstName",
          "type": "STRING"
        },
        {
          "name": "lastName",
          "type": "STRING"
        },
        {
          "name": "fullName",
          "type": "STRING"
        }
      ]
    },
    {
      "alias": "dced4642-b93d-4da4-815c-a171932043a4",
      "primaryKeyProperties": [
        "productIDK"
      ],
      "labels": [
        "products"
      ],
      "properties": [
        {
          "name": "productIDK",
          "type": "INT"
        },
        {
          "name": "productNumber",
          "type": "STRING"
        },
        {
          "name": "productName",
          "type": "STRING"
        },
        {
          "name": "modelName",
          "type": "STRING"
        },
        {
          "name": "makeFlag",
          "type": "INT"
        },
        {
          "name": "standardCost",
          "type": "FLOAT"
        },
        {
          "name": "listPrice",
          "type": "FLOAT"
        },
        {
          "name": "subCategoryIDFK",
          "type": "INT"
        }
      ]
    }
  ],
  "edgeTypes": [
    {
      "alias": "3ef6a474-ef38-4923-abcf-6f2e9230f1eb",
      "labels": [
        "customerProducts"
      ],
      "sourceNodeType": {
        "alias": "096a5133-fd82-4000-ac8a-404532ab6fd6"
      },
      "destinationNodeType": {
        "alias": "dced4642-b93d-4da4-815c-a171932043a4"
      },
      "properties": []
    }
  ]
}

Definície

Name	Description
EdgeType	Typ okraja grafu.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GraphType	Typ grafu, ktorý určuje štruktúru grafu.
NodeType	Typ uzla grafu.
NodeTypeReference	Odkaz na typ uzla.
Property	Vlastnosť prvku grafu.

EdgeType

Object

Typ okraja grafu.

Name	Typ	Description
alias	string	Alias typu okraja.
destinationNodeType	NodeTypeReference	Typ cieľového uzla.
labels	string[]	Označenia typu okraja.
properties	Property[]	Zoznam vlastností typu okraja.
sourceNodeType	NodeTypeReference	Typ uzla zdroja.

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.

GraphType

Object

Typ grafu, ktorý určuje štruktúru grafu.

Name	Typ	Description
edgeTypes	EdgeType[]	Zoznam typov okrajov grafu.
nodeTypes	NodeType[]	Zoznam typov uzla grafu.

NodeType

Object

Typ uzla grafu.

Name	Typ	Description
alias	string	Alias typu uzla.
labels	string[]	Označenia typu uzla.
primaryKeyProperties	string[]	Zoznam vlastností primárneho kľúča typu uzla.
properties	Property[]	Zoznam vlastností typu uzla.

NodeTypeReference

Object

Odkaz na typ uzla.

Name	Typ	Description
alias	string	Alias typu uzla.

Property

Object

Vlastnosť prvku grafu.

Name	Typ	Description
name	string	Názov vlastnosti.
type	string	Typ vlastnosti.