Items - Get Semantic Model Definition

Service:: SemanticModel

Versione API:: v1

Restituisce la definizione pubblica del modello semantico specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Quando si ottiene la definizione pubblica di un modello semantico, l'etichetta di riservatezza non fa parte della definizione.

Autorizzazioni

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per il modello semantico.

Ambiti delegati obbligatori

SemanticModel.ReadWrite.All o Item.ReadWrite.All

Limitazioni

Per recuperare la definizione di un elemento del modello semantico protetto da un'etichetta di riservatezza crittografata, il chiamante deve disporre di diritti di utilizzo sufficienti per rimuovere l'etichetta, come configurato in Microsoft Purview.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
semanticModelId	path	True	string (uuid)	ID modello semantico.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
format	query		string	Formato della definizione del modello semantico. I formati seguenti sono consentiti (con distinzione tra maiuscole e minuscole) TMDL TMSL Se non specificato, il valore predefinito è 'TMDL'.

Nome

Necessario

Tipo

Descrizione

semanticModelId

path

True

string (uuid)

ID modello semantico.

workspaceId

path

True

string (uuid)

L’ID dell’area di lavoro.

format

query

string

Formato della definizione del modello semantico.

I formati seguenti sono consentiti (con distinzione tra maiuscole e minuscole)

- TMDL
- TMSL

Se non specificato, il valore predefinito è 'TMDL'.

Risposte

Nome	Tipo	Descrizione
200 OK	SemanticModelDefinitionResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata. Il recupero della definizione è in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: OperationNotSupportedForItem: operazione non supportata per l'elemento richiesto.

Esempio

Get a semantic model definition example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
      }
    ]
  }
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.
SemanticModelDefinition	definizione pubblica del modello semantico oggetto . Per altre informazioni sulla struttura della definizione del modello semantico, vedere questo articolo .
SemanticModelDefinitionPart	Oggetto parte della definizione del modello semantico.
SemanticModelDefinitionResponse	Risposta alla definizione pubblica del modello semantico.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

SemanticModelDefinition

Oggetto

definizione pubblica del modello semantico oggetto . Per altre informazioni sulla struttura della definizione del modello semantico, vedere questo articolo .

Nome	Tipo	Descrizione
format	string	Formato della definizione del modello semantico.
parts	SemanticModelDefinitionPart[]	Elenco di parti di definizione.

SemanticModelDefinitionPart

Oggetto

Oggetto parte della definizione del modello semantico.

Nome	Tipo	Descrizione
path	string	Percorso della parte del modello semantico.
payload	string	Payload della parte del modello semantico.
payloadType	PayloadType	Tipo di payload.

SemanticModelDefinitionResponse

Oggetto

Risposta alla definizione pubblica del modello semantico.

Nome	Tipo	Descrizione
definition	SemanticModelDefinition	definizione pubblica del modello semantico oggetto . Per altre informazioni sulla struttura della definizione del modello semantico, vedere questo articolo .