Items - Create Report

Serviço:: Report

Versão API:: v1

Cria um relatório no espaço de trabalho especificado.
Esta API suporta operações de longa duração (LRO).

Esta API requer uma definição .

Permissões

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

Escopos delegados necessários

Report.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um item de relatório, o usuário deve ter a licença apropriada. Para obter mais informações, consulte: Tipos de licença do Microsoft Fabric.

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Sim

Interfaz

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Órgão do Pedido

Nome	Necessário	Tipo	Descrição
definition	True	ReportDefinition	A definição pública do relatório.
displayName	True	string	O nome de exibição do relatório. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
description		string	A descrição do relatório. O comprimento máximo é de 256 caracteres.
folderId		string (uuid)	O ID da pasta. Se não for especificado ou nulo, o relatório será criado com o espaço de trabalho como sua pasta.

Respostas

Nome	Tipo	Descrição
201 Created	Report	Criado com sucesso
202 Accepted		Pedido aceite, reporte de provisionamento em curso. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType - O tipo de item é inválido. ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado. CorruptedPayload - A carga fornecida está corrompida. WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Nome

Tipo

Descrição

201 Created

Report

Criado com sucesso

202 Accepted

Pedido aceite, reporte de provisionamento em curso.

Cabeçalhos

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType - O tipo de item é inválido.
ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado.
CorruptedPayload - A carga fornecida está corrompida.
WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Exemplos

Create a report example

Pedido de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/reports

{
  "displayName": "Report 1",
  "description": "A report description.",
  "definition": {
    "parts": [
      {
        "path": "definition.pbir",
        "payload": "ew0KICAidmVyc2lvbiI..sYVN0eWxlTGl2ZSINCiAgICB9DQogIH0NCn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": "report.json",
        "payload": "ewogICJjb25maWciOiA..3aWR0aCI6IDEyODAuMDAKICAgIH0KICBdCn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Resposta de exemplo

Código de estado:: 201

{
  "displayName": "Report 1",
  "description": "A report description.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Código de estado:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definições

Nome	Descrição
CreateReportRequest	Crie carga útil de solicitação de relatório.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemTag	Representa uma tag aplicada em um item.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
Report	Um objeto de relatório.
ReportDefinition	Objeto de definição pública de relatório. Consulte este artigo para obter mais detalhes sobre como elaborar uma definição pública de relatório.
ReportDefinitionPart	Objeto de parte de definição de relatório.

CreateReportRequest

Objetivo

Crie carga útil de solicitação de relatório.

Nome	Tipo	Descrição
definition	ReportDefinition	A definição pública do relatório.
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 para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
folderId	string (uuid)	O ID da pasta. Se não for especificado ou nulo, o relatório será criado com o espaço de trabalho como sua pasta.

ErrorRelatedResource

Objetivo

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Objetivo

A resposta de erro.

Nome	Tipo	Descrição
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

Objetivo

Os detalhes da resposta de erro.

Nome	Tipo	Descrição
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.

ItemTag

Objetivo

Representa uma tag aplicada em um item.

Nome	Tipo	Descrição
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

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

Valor	Descrição
Dashboard	Painel do PowerBI.
Report	Relatório do PowerBI.
SemanticModel	Modelo semântico do PowerBI.
PaginatedReport	Relatório paginado do PowerBI.
Datamart	Datamart do PowerBI.
Lakehouse	Uma casa no lago.
Eventhouse	Uma casa de eventos.
Environment	Um ambiente.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
KQLDashboard	Um painel KQL.
DataPipeline	Um pipeline de dados.
Notebook	Um caderno.
SparkJobDefinition	Uma definição de trabalho de faísca.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
Warehouse	Um armazém.
Eventstream	Um fluxo de eventos.
SQLEndpoint	Um ponto de extremidade SQL.
MirroredWarehouse	Um armazém espelhado.
MirroredDatabase	Um banco de dados espelhado.
Reflex	Um reflexo.
GraphQLApi	Uma API para o item GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Uma VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog	Um catálogo de databricks azure espelhado.
Map	Um mapa.
AnomalyDetector	Um detetor de anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent	Um Agente de Operações.
CosmosDBDatabase	Uma base de dados Cosmos DB.
Ontology	Uma ontologia.
EventSchemaSet	Um EventoSchemaSet.

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	Descrição
InlineBase64	Base em linha 64.

Report

Objetivo

Um objeto de relatório.

Nome	Tipo	Descrição
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	O ID da pasta.
id	string (uuid)	O ID do item.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O ID do espaço de trabalho.

ReportDefinition

Objetivo

Objeto de definição pública de relatório. Consulte este artigo para obter mais detalhes sobre como elaborar uma definição pública de relatório.

Nome	Tipo	Descrição
format	string	O formato da definição do item.
parts	ReportDefinitionPart[]	Uma lista de partes de definição.

ReportDefinitionPart

Objetivo

Objeto de parte de definição de relatório.

Nome	Tipo	Descrição
path	string	O caminho da parte do relatório.
payload	string	O relatório parte da carga útil.
payloadType	PayloadType	O tipo de carga útil.

Partilhar via

Items - Create Report

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Microsoft Entra

Interfaz

Parâmetros URI

Órgão do Pedido

Respostas

Exemplos

Create a report example

Pedido de exemplo

Resposta de exemplo

Definições

CreateReportRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

Report

ReportDefinition

ReportDefinitionPart