Partilhar via

Items - Get Semantic Model Definition

Serviço:
SemanticModel
Versão da API:
v1

Retorna a definição pública do modelo semântico especificado.
Esta API suporta operações de longa duração (LRO).

Quando você obtém a definição pública de um modelo semântico, o rótulo de sensibilidade não faz parte da definição.

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

Limitações

Essa API é bloqueada para um modelo semântico com um rótulo de sensibilidade criptografado.

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}/getDefinition
Com parâmetros opcionais: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/getDefinition?format={format}

Parâmetros do URI

Name Em Necessário Tipo Description
semanticModelId
 path True

string (uuid)

A ID do modelo semântico.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.
format
 query

string

O formato da definição do modelo semântico.

São permitidos os seguintes formatos (diferencia maiúsculas de minúsculas):

    • TMDL
    • TMSL

Se não for especificado, o padrão é 'TMDL'.

Respostas

Name Tipo Description
200 OK

SemanticModelDefinitionResponse

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. Está em curso a recuperação da definição.

Cabeçalhos

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

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get a semantic model definition example

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
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.
SemanticModelDefinitionPart

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

Modelo semântico: resposta de definição pública.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
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.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
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.
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 Description
InlineBase64

Base em linha 64.

SemanticModelDefinition

Object

Modelo semântico definição pública objeto.

Name Tipo Description
format

string

O formato da definição do item.
parts

SemanticModelDefinitionPart[]

Uma lista de partes de definição.

SemanticModelDefinitionPart

Object

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

Name Tipo Description
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.

SemanticModelDefinitionResponse

Object

Modelo semântico: resposta de definição pública.

Name Tipo Description
definition

SemanticModelDefinition

Modelo semântico definição pública objeto.