Items - Get Graph Model Definition

Hizmet:: GraphModel

API Sürümü:: v1

Belirtilen GraphModel genel tanımını döndürür.

Uyarı

GraphModel öğesi şu anda Önizleme aşamasındadır (daha fazla bilgi edinin).

Bu API, uzun süre çalışan işlemleri (LRO)destekler.

GraphModel'in genel tanımını aldığınızda duyarlılık etiketi tanımın bir parçası değildir.

Permissions

Çağıranın GraphModel için okuma ve yazma izinlerine sahip olması gerekir.

Gerekli Temsilci Kapsamları

Item.ReadWrite.All

Limitations

Şifrelenmiş duyarlılık etiketiyle korunan bir grafik modeli öğesinin tanımını almak için çağıranın, Microsoft Purview'de yapılandırıldığı gibi etiketi kaldırmak için yeterli kullanım haklarına sahip olması gerekir.

Desteklenen kimlikleri Microsoft Entra

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Support
User	Yes
Hizmet sorumlusu ve yönetilen kimlikler	Yes

Arayüz

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
graphModelId	path	True	string (uuid)	GraphModel Kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
format	query		string	GraphModel genel tanımının biçimi.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	GraphModelDefinitionResponse	İstek başarıyla tamamlandı.
202 Accepted		İstek kabul edildi. Tanımı alma işlemi devam ediyor. Üst Bilgiler Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor.

Örnekler

Get a GraphModel public definition example

Örnek isteği

HTTP

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

Örnek yanıt

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

Durum kodu:: 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

Tanımlar

Veri Akışı Adı	Description
ErrorParameter	Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
GraphModelDefinitionFormat	Grafik modeli tanımının biçimi. Zaman içinde ek `format` türleri eklenebilir.
GraphModelDefinitionResponse	GraphModel genel tanım yanıtı.
GraphModelPublicDefinition	GraphModel genel tanım nesnesi. GraphModel tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.
GraphModelPublicDefinitionPart	GraphModel tanımı parça nesnesi.
PayloadType	Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

ErrorParameter

Nesne

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

Veri Akışı Adı	Tür	Description
message	string	Parametrenin anlamının insan tarafından okunabilen açıklaması.
name	string	Parametre tanımlayıcısı.
value	string	Parametre değeridir.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Veri Akışı Adı	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Veri Akışı Adı	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
parameters	ErrorParameter[]	Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Veri Akışı Adı	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
parameters	ErrorParameter[]	Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

GraphModelDefinitionFormat

Numaralandırma

Grafik modeli tanımının biçimi. Zaman içinde ek format türleri eklenebilir.

Değer	Description
json	GraphModel genel tanımı için JSON biçimi, özellikle Doku'daki CI/CD senaryolarını desteklemek üzere tasarlanmıştır.

GraphModelDefinitionResponse

Nesne

GraphModel genel tanım yanıtı.

Veri Akışı Adı	Tür	Description
definition	GraphModelPublicDefinition	GraphModel genel tanım nesnesi. GraphModel tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

GraphModelPublicDefinition

Nesne

GraphModel genel tanım nesnesi. GraphModel tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

Veri Akışı Adı	Tür	Description
format	GraphModelDefinitionFormat	Grafik modeli tanımının biçimi. Zaman içinde ek `format` türleri eklenebilir.
parts	GraphModelPublicDefinitionPart[]	Tanım bölümlerinin listesi.

GraphModelPublicDefinitionPart

Nesne

GraphModel tanımı parça nesnesi.

Veri Akışı Adı	Tür	Description
path	string	GraphModel genel tanımı parça yolu.
payload	string	GraphModel genel tanımı parça yükü.
payloadType	PayloadType	Yük türü.

PayloadType

Numaralandırma

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer	Description
InlineBase64	Satır içi Temel 64.