Items - Update Semantic Model Definition

Service:: SemanticModel

Versione API:: v1

Esegue l'override della definizione per il modello semantico specificato.
Questa API supporta operazioni con esecuzione prolungata (LRO).

L'aggiornamento della definizione del modello semantico non influisce sull'etichetta di riservatezza.

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

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}/updateDefinition

Con parametri facoltativi:

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

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.
updateMetadata	query		boolean	Se impostato su true e il file con estensione platform viene fornito come parte della definizione, i metadati dell'elemento vengono aggiornati usando i metadati nel file con estensione platform

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
definition	True	SemanticModelDefinition	definizione pubblica del modello semantico oggetto . Per altre informazioni sulla struttura della definizione del modello semantico, vedere questo articolo .
options		SemanticModelDefinitionOptions	Opzioni per il modello semantico la cui definizione viene aggiornata.

Risposte

Nome	Tipo	Descrizione
200 OK		Richiesta completata correttamente.
202 Accepted		Richiesta accettata. La definizione di aggiornamento è 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. CorruptedPayload: il payload fornito è danneggiato.

Esempio

Update a semantic model definition example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "model.bim",
        "payload": "ewogICJjb21wYXRpYmlsaXR5TGV2ZW..GVzIjogWyBdDQogIH0NCn0",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "ewogICJ2ZXJzaW9uIjogIjQuMC..HRpbmdzIjoge30KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Risposta di esempio

Codice di stato:: 200

Codice di stato:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
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 .
SemanticModelDefinitionOptions	Opzioni applicabili durante la creazione di un modello semantico con una definizione o l'aggiornamento della definizione di un modello semantico.
SemanticModelDefinitionPart	Oggetto parte della definizione del modello semantico.
UpdateSemanticModelDefinitionRequest	Aggiornare il payload della richiesta di 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.

SemanticModelDefinitionOptions

Oggetto

Opzioni applicabili durante la creazione di un modello semantico con una definizione o l'aggiornamento della definizione di un modello semantico.

Nome	Tipo	Descrizione
allowPurgeData	boolean	Indica se consentire l'eliminazione dei dati esistenti del modello semantico quando si applica la definizione aggiornata. Alcune modifiche alla definizione richiedono la cancellazione dei dati esistenti; impostare su true per consentire l'esecuzione di tali modifiche, nel qual caso tutti i dati che non possono essere conservati nella nuova definizione vengono eliminati. Al termine dell'operazione, aggiornare il modello semantico per ricaricare i dati. Il valore predefinito è false.

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.

UpdateSemanticModelDefinitionRequest

Oggetto

Aggiornare il payload della richiesta di 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 .
options	SemanticModelDefinitionOptions	Opzioni per il modello semantico la cui definizione viene aggiornata.