Items - Get Graph Model Definition

Servicio:: GraphModel

Versión de la API:: v1

Devuelve la definición pública de GraphModel especificada.

Nota:

El elemento GraphModel se encuentra actualmente en versión preliminar (más información).

Esta API admite operaciones de larga duración (LRO).

Cuando se obtiene la definición pública de GraphModel, la etiqueta de confidencialidad no forma parte de la definición.

Permissions

El autor de la llamada debe tener permisos de lectura y escritura para GraphModel.

Ámbitos delegados necesarios

Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

identidad	Support
Usuario	Sí
Entidad de servicio e Identidades administradas	No

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getDefinition

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
GraphModelId	path	True	string (uuid)	Id. de GraphModel.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
format	query		string	Formato de la definición pública de GraphModel.

Respuestas

Nombre	Tipo	Description
200 OK	GraphModelDefinitionResponse	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 GraphModel public definition example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "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
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
GraphModelDefinitionFormat	Formato de la definición de elemento. Se pueden agregar tipos de `format` adicionales a lo largo del tiempo.
GraphModelDefinitionResponse	Respuesta de definición pública de GraphModel.
GraphModelPublicDefinition	Objeto de definición pública de GraphModel. Consulte este artículo para obtener más información sobre cómo crear una definición pública de GraphModel.
GraphModelPublicDefinitionPart	Objeto de parte de definición de GraphModel.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

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.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
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.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

GraphModelDefinitionFormat

Enumeración

Formato de la definición de elemento. Se pueden agregar tipos de format adicionales a lo largo del tiempo.

Valor	Description
json	Formato JSON para la definición pública de GraphModel, diseñado específicamente para admitir escenarios de CI/CD en Fabric.

GraphModelDefinitionResponse

Objeto

Respuesta de definición pública de GraphModel.

Nombre	Tipo	Description
definition	GraphModelPublicDefinition	Objeto de definición pública de GraphModel. Consulte este artículo para obtener más información sobre cómo crear una definición pública de GraphModel.

GraphModelPublicDefinition

Objeto

Objeto de definición pública de GraphModel. Consulte este artículo para obtener más información sobre cómo crear una definición pública de GraphModel.

Nombre	Tipo	Description
format	GraphModelDefinitionFormat	Formato de la definición de elemento. Se pueden agregar tipos de `format` adicionales a lo largo del tiempo.
parts	GraphModelPublicDefinitionPart[]	Lista de elementos de definición.

GraphModelPublicDefinitionPart

Objeto

Objeto de parte de definición de GraphModel.

Nombre	Tipo	Description
path	string	Ruta de acceso de elemento de definición pública de GraphModel.
payload	string	Carga del elemento de definición pública de GraphModel.
payloadType	PayloadType	Tipo de carga útil.

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.

Compartir a través de

Items - Get Graph Model Definition

Permissions

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

Get a GraphModel public definition example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModelDefinitionFormat

GraphModelDefinitionResponse

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

PayloadType