Items - Get Semantic Model Definition

Servicio:: SemanticModel

Versión de la API:: v1

Devuelve la definición pública del modelo semántico especificado.
Esta API admite operaciones de larga duración (LRO).

Cuando se obtiene la definición pública de un modelo semántico, la etiqueta de confidencialidad no forma parte de la definición.

Permisos

El autor de la llamada debe tener permisos de lectura y escritura para el modelo semántico.

Ámbitos delegados necesarios

SemanticModel.ReadWrite.All o Item.ReadWrite.All

Limitaciones

Para recuperar la definición de un elemento de modelo semántico protegido por una etiqueta de confidencialidad cifrada, el autor de la llamada debe tener suficientes derechos de uso para quitar la etiqueta, tal como se ha configurado en Microsoft Purview.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
semanticModelId	path	True	string (uuid)	Identificador del modelo semántico.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
format	query		string	Formato de la definición del modelo semántico. Se permiten los siguientes formatos (distingue mayúsculas de minúsculas) TMDL TMSL Si no se especifica, el valor predeterminado es "TMDL".

Nombre

Requerido

Tipo

Description

semanticModelId

path

True

string (uuid)

Identificador del modelo semántico.

workspaceId

path

True

string (uuid)

El identificador del área de trabajo.

format

query

string

Formato de la definición del modelo semántico.

Se permiten los siguientes formatos (distingue mayúsculas de minúsculas)

- TMDL
- TMSL

Si no se especifica, el valor predeterminado es "TMDL".

Respuestas

Nombre	Tipo	Description
200 OK	SemanticModelDefinitionResponse	Solicitud completada correctamente.
202 Accepted		Solicitud aceptada. La recuperación de la definición está en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: OperationNotSupportedForItem: no se admite la operación para el elemento solicitado.

Ejemplos

Get a semantic model definition example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
      }
    ]
  }
}

status code:: 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

Definiciones

Nombre	Description
ErrorParameter	Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
SemanticModelDefinition	objeto de definición pública del modelo semántico. Consulte este artículo para obtener más información sobre la estructura de la definición del modelo semántico.
SemanticModelDefinitionPart	Objeto de parte de definición de modelo semántico.
SemanticModelDefinitionResponse	Respuesta de definición pública del modelo semántico.

ErrorParameter

Objeto

Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.

Nombre	Tipo	Description
message	string	Descripción legible del significado del parámetro.
name	string	El identificador de parámetros.
value	string	Es el valor del parámetro.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

SemanticModelDefinition

Objeto

objeto de definición pública del modelo semántico. Consulte este artículo para obtener más información sobre la estructura de la definición del modelo semántico.

Nombre	Tipo	Description
format	string	Formato de la definición del modelo semántico.
parts	SemanticModelDefinitionPart[]	Lista de elementos de definición.

SemanticModelDefinitionPart

Objeto

Objeto de parte de definición de modelo semántico.

Nombre	Tipo	Description
path	string	Ruta de acceso del elemento del modelo semántico.
payload	string	Carga del elemento del modelo semántico.
payloadType	PayloadType	Tipo de carga.

SemanticModelDefinitionResponse

Objeto

Respuesta de definición pública del modelo semántico.

Nombre	Tipo	Description
definition	SemanticModelDefinition	objeto de definición pública del modelo semántico. Consulte este artículo para obtener más información sobre la estructura de la definición del modelo semántico.