Items - Get Graph Model Definition

Služba:: GraphModel

Verzia rozhrania API:: v1

Vráti zadanú verejnú definíciu GraphModel.

Poznámka

Položka GraphModel je momentálne v režime ukážky (ďalšie informácie).

Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Keď sa zobrazí verejná definícia GraphModelu, označenie citlivosti nie je súčasťou definície.

Povolenia

Volajúci musí mať povolenia na čítanie a zápis pre model GraphModel.

Povinné delegované rozsahy

Item.ReadWrite.All

podporované identity Microsoft Entra

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

Identita	Podpora
User	Áno
Objekt služby a spravované identity	Áno

Rozhranie

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition

S voliteľnými parametrami:

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

Parametre URI

Name	V	Povinné	Typ	Description
graphModelId	path	True	string (uuid)	Id modelu GraphModel.
workspaceId	path	True	string (uuid)	ID pracovného priestoru.
format	query		string	Formát verejnej definície GraphModel.

Odpovede

Name	Typ	Description
200 OK	GraphModelDefinitionResponse	Požiadavka sa úspešne dokončila.
202 Accepted		Žiadosť prijatá. Načítanie definície prebieha. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
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.

Príklady

Get a GraphModel public definition example

Vzorová požiadavka

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/graphModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Vzorová odpoveď

Kód stavu:: 200

{
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Kód stavu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definície

Name	Description
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GraphModelDefinitionFormat	Formát definície modelu grafu. V priebehu času je možné pridať ďalšie typy #D0.
GraphModelDefinitionResponse	Odpoveď verejnej definície GraphModel.
GraphModelPublicDefinition	Objekt verejnej definície GraphModel. V tomto článku nájdete ďalšie podrobnosti o štruktúre definície GraphModel.
GraphModelPublicDefinitionPart	Časť objektu definície GraphModel.
PayloadType	Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

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.

GraphModelDefinitionFormat

Enumerácia

Formát definície modelu grafu. V priebehu času je možné pridať ďalšie typy #D0.

Hodnota	Description
json	Formát JSON pre verejnú definíciu GraphModel, špeciálne navrhnutú na podporu scenárov CI/CD v službe Fabric.

GraphModelDefinitionResponse

Object

Odpoveď verejnej definície GraphModel.

Name	Typ	Description
definition	GraphModelPublicDefinition	Objekt verejnej definície GraphModel. V tomto článku nájdete ďalšie podrobnosti o štruktúre definície GraphModel.

GraphModelPublicDefinition

Object

Objekt verejnej definície GraphModel. V tomto článku nájdete ďalšie podrobnosti o štruktúre definície GraphModel.

Name	Typ	Description
format	GraphModelDefinitionFormat	Formát definície modelu grafu. V priebehu času je možné pridať ďalšie typy #D0.
parts	GraphModelPublicDefinitionPart[]	Zoznam častí definície.

GraphModelPublicDefinitionPart

Object

Časť objektu definície GraphModel.

Name	Typ	Description
path	string	Cesta k verejnej definícii GraphModel.
payload	string	Časť údajovej časti služby GraphModel – verejná definícia.
payloadType	PayloadType	Typ údajovej časti.

PayloadType

Enumerácia

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

Hodnota	Description
InlineBase64	Inline Base 64.