Compartilhar via

Items - Update Report

  • Referência
Serviço:
Report
Versão da API:
v1

Atualiza as propriedades do relatório especificado.

Permissões

O chamador deve ter função de colaborador ou de espaço de trabalho superior.

Escopos delegados necessários

Report.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interface

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
reportId
 path True

string

uuid

A ID do relatório.
workspaceId
 path True

string

uuid

A ID do workspace.

Corpo da solicitação

Nome Tipo Description
description

string

A descrição do relatório. O comprimento máximo é de 256 caracteres.
displayName

string

O nome de exibição do relatório. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

Respostas

Nome Tipo Description
200 OK

Report

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

  • InvalidRequest – Solicitação de atualização inválida

Exemplos

Update a report example

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemType

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
Report

Um objeto de relatório.
UpdateReportRequest

Atualizar solicitação de relatório.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um Reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho do Spark.
Warehouse

Um armazém.

Report

Objeto

Um objeto de relatório.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

A ID do item.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

UpdateReportRequest

Objeto

Atualizar solicitação de relatório.

Nome Tipo Description
description

string

A descrição do relatório. O comprimento máximo é de 256 caracteres.
displayName

string

O nome de exibição do relatório. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.