Compartir a través de

Items - Update Report

  • Referencia
Servicio:
Report
Versión de la API:
v1

Actualiza las propiedades del informe especificado.

Permisos

El autor de la llamada debe tener rol de colaborador o superior.

Ámbitos delegados necesarios

Report.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

Identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Sí

Interfaz

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
reportId
 path True

string

uuid

Identificador del informe.
workspaceId
 path True

string

uuid

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Tipo Description
description

string

Descripción del informe. La longitud máxima es de 256 caracteres.
displayName

string

Nombre para mostrar del informe. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

Respuestas

Nombre Tipo Description
200 OK

Report

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • ItemNotFound: no se encontró el elemento solicitado.

  • InvalidRequest: solicitud de actualización no válida

Ejemplos

Update a report example

Solicitud de ejemplo

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff211/reports/5b218778-e7a5-4d73-8187-f10824047721

{
  "displayName": "Report's New name",
  "description": "A new description for report."
}

Respuesta de muestra

status code:
200 
{
  "displayName": "Report's New name",
  "description": "A new description for report.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff211",
  "id": "5b218778-e7a5-4d73-8187-f10824047721"
}

Definiciones

Nombre Description
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
ItemType

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
Report

Objeto de informe.
UpdateReportRequest

Actualizar solicitud de informe.

ErrorRelatedResource

Object

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

Object

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

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor Description
Dashboard

Panel de PowerBI.
DataPipeline

Una canalización de datos.
Datamart

Datamart de PowerBI.
Environment

Un entorno.
Eventhouse

Un centro de eventos.
Eventstream

Una secuencia de eventos.
GraphQLApi

Una API para el elemento GraphQL.
KQLDashboard

Un panel de KQL.
KQLDatabase

Una base de datos KQL.
KQLQueryset

Un conjunto de consultas KQL.
Lakehouse

Una casa de lago.
MLExperiment

Un experimento de aprendizaje automático.
MLModel

Un modelo de aprendizaje automático.
MirroredDatabase

Una base de datos reflejada.
MirroredWarehouse

Un almacén reflejado.
MountedDataFactory

A MountedDataFactory.
Notebook

Un cuaderno.
PaginatedReport

Informe paginado de PowerBI.
Reflex

Un reflejo.
Report

Informe de PowerBI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Un punto de conexión de SQL.
SemanticModel

Modelo semántico de PowerBI.
SparkJobDefinition

Una definición de trabajo de Spark.
Warehouse

Un almacén.

Report

Object

Objeto de informe.

Nombre Tipo Description
description

string

Descripción del elemento.
displayName

string

Nombre para mostrar del elemento.
id

string

uuid

Identificador del elemento.
type

ItemType

Tipo de elemento.
workspaceId

string

uuid

Identificador del área de trabajo.

UpdateReportRequest

Object

Actualizar solicitud de informe.

Nombre Tipo Description
description

string

Descripción del informe. La longitud máxima es de 256 caracteres.
displayName

string

Nombre para mostrar del informe. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.