Items - Create Report

Tjänst:: Report

API-versionen:: v1

Skapar en rapport på den angivna arbetsytan.
Det här API:et stöder tidskrävande åtgärder (LRO).

Det här API:et kräver en definition.

Behörigheter

Anroparen måste ha rollen deltagare i arbetsytan.

Obligatoriska delegerade omfång

Report.ReadWrite.All eller Item.ReadWrite.All

Begränsningar

Om du vill skapa ett rapportobjekt måste användaren ha rätt licens. Mer information finns i: Microsoft Fabric-licenstyper.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
workspaceId	path	True	string (uuid)	Arbetsytans ID.

Begäranarorgan

Namn	Krävs	Typ	Beskrivning
definition	True	ReportDefinition	Rapportens offentliga definition.
displayName	True	string	Rapportens visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.
description		string	Rapportbeskrivningen. Maximal längd är 256 tecken.
folderId		string (uuid)	Mapp-ID:t. Om den inte anges eller är null skapas rapporten med arbetsytan som mapp.

Svaren

Namn	Typ	Beskrivning
201 Created	Report	Har skapats
202 Accepted		Begäran accepterad, rapportetablering pågår. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Objekttypen är ogiltig. ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan. CorruptedPayload – den angivna nyttolasten är skadad. WorkspaceItemsLimitExceeded – Gränsen för arbetsyteobjekt har överskridits.

Namn

Typ

Beskrivning

201 Created

Report

Har skapats

202 Accepted

Begäran accepterad, rapportetablering pågår.

Headers

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

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Objekttypen är ogiltig.
ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan.
CorruptedPayload – den angivna nyttolasten är skadad.
WorkspaceItemsLimitExceeded – Gränsen för arbetsyteobjekt har överskridits.

Exempel

Create a report example

Exempelförfrågan

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

Exempelsvar

Statuskod:: 201

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

Statuskod:: 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

Definitioner

Namn	Beskrivning
CreateReportRequest	Skapa nyttolast för rapportbegäran.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.
Report	Ett rapportobjekt.
ReportDefinition	Rapportera offentligt definitionsobjekt. Mer information om hur du skapar en offentlig rapportdefinition finns i den här artikeln.
ReportDefinitionPart	Rapportdefinitionsdelsobjekt.

CreateReportRequest

Objekt

Skapa nyttolast för rapportbegäran.

Namn	Typ	Beskrivning
definition	ReportDefinition	Rapportens offentliga definition.
description	string	Rapportbeskrivningen. Maximal längd är 256 tecken.
displayName	string	Rapportens visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.
folderId	string (uuid)	Mapp-ID:t. Om den inte anges eller är null skapas rapporten med arbetsytan som mapp.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Namn	Typ	Beskrivning
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Namn	Typ	Beskrivning
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Beskrivning
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Beskrivning
InlineBase64	Infogad bas 64.

Report

Objekt

Ett rapportobjekt.

Namn	Typ	Beskrivning
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
folderId	string (uuid)	Mapp-ID:t.
id	string (uuid)	Objekt-ID:t.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen.
workspaceId	string (uuid)	Arbetsytans ID.

ReportDefinition

Objekt

Rapportera offentligt definitionsobjekt. Mer information om hur du skapar en offentlig rapportdefinition finns i den här artikeln.

Namn	Typ	Beskrivning
format	string	Formatet för objektdefinitionen.
parts	ReportDefinitionPart[]	En lista över definitionsdelar.

ReportDefinitionPart

Objekt

Rapportdefinitionsdelsobjekt.

Namn	Typ	Beskrivning
path	string	Sökvägen till rapportdelen.
payload	string	Rapportdelens nyttolast.
payloadType	PayloadType	Nyttolasttypen.

Dela via

Items - Create Report

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begäranarorgan

Svaren

Exempel

Create a report example

Exempelförfrågan

Exempelsvar

Definitioner

CreateReportRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

Report

ReportDefinition

ReportDefinitionPart