Items - Get Graph Model Definition

Palvelu:: GraphModel

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyn GraphModelin julkisen määrityksen.

Note

GraphModel-kohde on tällä hetkellä esikatselussa (lisätietoja).

Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Kun saat GraphModelin julkisen määrityksen, luottamuksellisuustunniste ei ole osa määritelmää.

Oikeudet

Soittajalla on oltava GraphModel-mittarin luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

Item.ReadWrite.All

Rajoitukset

Jotta soittaja voi noutaa salatulla luottamuksellisuustunnisteella suojatun kaaviomallikohteen määrityksen, hänellä on oltava riittävät käyttöoikeudet tunnisteen poistamiseen, kuten Microsoft Purview on määritetty.

tuettujen käyttäjätietojen Microsoft Entra

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

Käyttäjätiedot	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}/getDefinition

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
graphModelId	path	True	string (uuid)	GraphModel-tunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
format	query		string	GraphModelin julkisen määrityksen muoto.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK	GraphModelDefinitionResponse	Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Määrityksen noutaminen on kesken. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
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.

Esimerkit

Get a GraphModel public definition example

Mallipyyntö

HTTP

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

Mallivastaus

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

Tilakoodi:: 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

Määritelmät

Nimi	Kuvaus
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GraphModelDefinitionFormat	Kaaviomallin määrityksen muoto. Muita `format` tyyppejä voidaan lisätä ajan kuluessa.
GraphModelDefinitionResponse	GraphModelin julkinen määritysvastaus.
GraphModelPublicDefinition	GraphModelin julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja GraphModel-määritelmän rakenteesta.
GraphModelPublicDefinitionPart	GraphModel-määritelmäosaobjekti.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
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ä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GraphModelDefinitionFormat

Luettelointi

Kaaviomallin määrityksen muoto. Muita format tyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
json	GraphModelin julkisen määrityksen JSON-muoto, joka on suunniteltu erityisesti tukemaan Ci/CD-skenaarioita Fabricissa.

GraphModelDefinitionResponse

Kohde

GraphModelin julkinen määritysvastaus.

Nimi	Tyyppi	Kuvaus
definition	GraphModelPublicDefinition	GraphModelin julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja GraphModel-määritelmän rakenteesta.

GraphModelPublicDefinition

Kohde

GraphModelin julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja GraphModel-määritelmän rakenteesta.

Nimi	Tyyppi	Kuvaus
format	GraphModelDefinitionFormat	Kaaviomallin määrityksen muoto. Muita `format` tyyppejä voidaan lisätä ajan kuluessa.
parts	GraphModelPublicDefinitionPart[]	Luettelo määritysosista.

GraphModelPublicDefinitionPart

Kohde

GraphModel-määritelmäosaobjekti.

Nimi	Tyyppi	Kuvaus
path	string	GraphModelin julkisen määrityksen osan polku.
payload	string	GraphModelin julkisen määritelmän osakuormitus.
payloadType	PayloadType	Hyötykuorman tyyppi.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
InlineBase64	Inline Base 64.