Udostępnij przez

Items - Get Semantic Model Definition

Usługa:
SemanticModel
Wersja interfejsu API:
v1

Zwraca określoną definicję publiczną modelu semantycznego.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Gdy uzyskasz publiczną definicję modelu semantycznego, etykieta poufności nie jest częścią definicji.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla modelu semantycznego.

Wymagane zakresy delegowane

SemanticModel.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Ten interfejs API jest blokowany dla modelu semantycznego z zaszyfrowaną etykietą poufności.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
semanticModelId
 path True

string (uuid)

Identyfikator modelu semantycznego.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
format
 query

string

Format definicji modelu semantycznego.

Dozwolone są następujące formaty (uwzględniana wielkość liter)

    • TMDL
    • TMSL

Jeśli nie zostanie określony, wartość domyślna to "TMDL".

Odpowiedzi

Nazwa Typ Opis
200 OK

SemanticModelDefinitionResponse

Żądanie zostało ukończone pomyślnie.
202 Accepted

Zaakceptowano żądanie. Pobieranie definicji jest w toku.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

Przykłady

Get a semantic model definition example

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
PayloadType

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
SemanticModelDefinition

obiekt definicji publicznej modelu semantycznego.
SemanticModelDefinitionPart

Obiekt części definicji modelu semantycznego.
SemanticModelDefinitionResponse

Odpowiedź na definicję publiczną modelu semantycznego.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość Opis
InlineBase64

Śródliniowa baza 64.

SemanticModelDefinition

Objekt

obiekt definicji publicznej modelu semantycznego.

Nazwa Typ Opis
format

string

Format definicji elementu.
parts

SemanticModelDefinitionPart[]

Lista części definicji.

SemanticModelDefinitionPart

Objekt

Obiekt części definicji modelu semantycznego.

Nazwa Typ Opis
path

string

Semantyczna ścieżka części modelu.
payload

string

Ładunek części modelu semantycznego.
payloadType

PayloadType

Typ ładunku.

SemanticModelDefinitionResponse

Objekt

Odpowiedź na definicję publiczną modelu semantycznego.

Nazwa Typ Opis
definition

SemanticModelDefinition

obiekt definicji publicznej modelu semantycznego.