Items - Get Semantic Model Definition

Hizmet:: SemanticModel

API Sürümü:: v1

Belirtilen anlamsal model ortak tanımını döndürür.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Anlamsal modelin genel tanımını aldığınızda duyarlılık etiketi tanımın bir parçası değildir.

İzinler

Çağıranın anlam modeli için okuma ve yazma izinleri olmalıdır.

Gerekli Temsilci Kapsamları

SemanticModel.ReadWrite.All veya Item.ReadWrite.All

Sınırlamalar

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

Microsoft Entra destekli kimlikler

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

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Evet

Arayüz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/getDefinition

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
semanticModelId	path	True	string (uuid)	Anlamsal model kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
format	query		string	Anlam modeli tanımının biçimi. Aşağıdaki biçimlere izin verilir (büyük/küçük harfe duyarlı) TMDL TMSL Belirtilmezse, varsayılan değer 'TMDL'dir.

Veri Akışı Adı

İçinde

Gerekli

Tür

Description

semanticModelId

path

True

string (uuid)

Anlamsal model kimliği.

workspaceId

path

True

string (uuid)

Çalışma alanı kimliği.

format

query

string

Anlam modeli tanımının biçimi.

Aşağıdaki biçimlere izin verilir (büyük/küçük harfe duyarlı)

- TMDL
- TMSL

Belirtilmezse, varsayılan değer 'TMDL'dir.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	SemanticModelDefinitionResponse	İ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 semantic model definition example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "definition/database.tmdl",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition/model.tmdl",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition/tables/Table1.tmdl",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "<base64 encoded string>",
        "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ı.
PayloadType	Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.
SemanticModelDefinition	Anlam modeli genel tanımı nesnesi. Anlam modeli tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.
SemanticModelDefinitionPart	Anlamsal model tanımı parça nesnesi.
SemanticModelDefinitionResponse	Anlamsal model genel tanım yanıtı.

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ı.

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.

SemanticModelDefinition

Nesne

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

Veri Akışı Adı	Tür	Description
format	string	Anlam modeli tanımının biçimi.
parts	SemanticModelDefinitionPart[]	Tanım bölümlerinin listesi.

SemanticModelDefinitionPart

Nesne

Anlamsal model tanımı parça nesnesi.

Veri Akışı Adı	Tür	Description
path	string	Anlamsal model parça yolu.
payload	string	Anlamsal model parça yükü.
payloadType	PayloadType	Yük türü.

SemanticModelDefinitionResponse

Nesne

Anlamsal model genel tanım yanıtı.

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