Items - Update Semantic Model Definition

Serviço:: SemanticModel

Versão da API:: v1

Substitui a definição para o modelo semântico especificado.
Esta API suporta operações de longa duração (LRO).

A atualização da definição do modelo semântico não afeta seu rótulo de sensibilidade.

Permissões

O chamador deve ter permissões de leitura e gravação para o modelo semântico.

Escopos delegados necessários

SemanticModel.ReadWrite.All ou Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades geridas	Sim

Interfaz

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

Com parâmetros opcionais:

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

Parâmetros do URI

Nome	Em	Obrigatório	Tipo	Descrição
semanticModelId	path	True	string (uuid)	A ID do modelo semântico.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
updateMetadata	query		boolean	Quando definido como true e o arquivo .platform é fornecido como parte da definição, os metadados do item são atualizados usando os metadados no arquivo .platform

Corpo do Pedido

Nome	Obrigatório	Tipo	Descrição
definition	True	SemanticModelDefinition	Modelo semântico definição pública objeto. Consulte este artigo para mais detalhes sobre a estrutura da definição do modelo semântico.
options		SemanticModelDefinitionOptions	Opções para o modelo semântico cuja definição está a ser atualizada.

Respostas

Nome	Tipo	Descrição
200 OK		Pedido concluído com sucesso.
202 Accepted		Pedido aceite. A definição de atualização está em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um `Retry-After` cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem - Operação não suportada para o item solicitado. CorruptedPayload - A carga fornecida está corrompida.

Exemplos

Update a semantic model definition example

Pedido de amostra

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"
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 200

Código de estado:: 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

Definições

Nome	Descrição
ErrorParameter	Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
SemanticModelDefinition	Modelo semântico definição pública objeto. Consulte este artigo para mais detalhes sobre a estrutura da definição do modelo semântico.
SemanticModelDefinitionOptions	Opções que se aplicam ao criar um modelo semântico com uma definição ou atualizar a definição de um modelo semântico.
SemanticModelDefinitionPart	Objeto de parte de definição de modelo semântico.
UpdateSemanticModelDefinitionRequest	Atualize a carga útil da solicitação de definição pública do modelo semântico.

ErrorParameter

Object

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.

Nome	Tipo	Descrição
message	string	Uma descrição legível para humanos do significado do parâmetro.
name	string	O identificador de parâmetro.
value	string	O valor do parâmetro.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Nome	Tipo	Descrição
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
isRetriable	boolean	Quando confirmado, o pedido pode ser retentado. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Nome	Tipo	Descrição
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor	Descrição
InlineBase64	Base em linha 64.

SemanticModelDefinition

Object

Modelo semântico definição pública objeto. Consulte este artigo para mais detalhes sobre a estrutura da definição do modelo semântico.

Nome	Tipo	Descrição
format	string	O formato da definição do modelo semântico.
parts	SemanticModelDefinitionPart[]	Uma lista de partes de definição.

SemanticModelDefinitionOptions

Object

Opções que se aplicam ao criar um modelo semântico com uma definição ou atualizar a definição de um modelo semântico.

Nome	Tipo	Descrição
allowPurgeData	boolean	Se deve permitir a purga dos dados existentes do modelo semântico ao aplicar a definição atualizada. Algumas alterações de definição exigem que os dados existentes sejam apagados; definir isto como verdadeiro para permitir que essas alterações prossigam, caso em que quaisquer dados que não possam ser mantidos sob a nova definição são eliminados. Após a conclusão da operação, atualize o modelo semântico para recarregar os dados. O valor predefinido é falso.

SemanticModelDefinitionPart

Object

Objeto de parte de definição de modelo semântico.

Nome	Tipo	Descrição
path	string	O caminho da parte do modelo semântico.
payload	string	A carga útil parcial do modelo semântico.
payloadType	PayloadType	O tipo de carga útil.

UpdateSemanticModelDefinitionRequest

Object

Atualize a carga útil da solicitação de definição pública do modelo semântico.

Nome	Tipo	Descrição
definition	SemanticModelDefinition	Modelo semântico definição pública objeto. Consulte este artigo para mais detalhes sobre a estrutura da definição do modelo semântico.
options	SemanticModelDefinitionOptions	Opções para o modelo semântico cuja definição está a ser atualizada.