Items - Create Report

Referenz

Dienst:: Report

API-Version:: v1

Erstellt einen Bericht im angegebenen Arbeitsbereich.
Diese API unterstützt LRO-.

Für diese API ist eine Definitionerforderlich.

Erlaubnisse

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Report.ReadWrite.All oder Item.ReadWrite.All

Begrenzungen

Zum Erstellen eines Berichtselements muss der Benutzer über die entsprechende Lizenz verfügen. Weitere Informationen finden Sie unter: Microsoft Fabric-Lizenztypen.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützen
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string uuid	Die Arbeitsbereichs-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
definition	True	ReportDefinition	Die öffentliche Berichtsdefinition.
displayName	True	string	Der Anzeigename des Berichts. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
description		string	Die Berichtsbeschreibung. Die maximale Länge beträgt 256 Zeichen.

Antworten

Name	Typ	Beschreibung
201 Created	Report	Erfolgreich erstellt
202 Accepted		Fordern Sie die akzeptierte Anforderung an, melden Sie die Bereitstellung in Bearbeitung. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InvalidItemType – Elementtyp ist ungültig. ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet. CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Name

Typ

Beschreibung

201 Created

Report

Erfolgreich erstellt

202 Accepted

Fordern Sie die akzeptierte Anforderung an, melden Sie die Bereitstellung in Bearbeitung.

Header

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

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

InvalidItemType – Elementtyp ist ungültig.
ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet.
CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Create a report example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 201

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

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

Definitionen

Name	Beschreibung
CreateReportRequest	Erstellen Sie berichtsanforderungsnutzlast.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ItemType	Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
Report	Ein Berichtsobjekt.
ReportDefinition	Öffentliches Definitionsobjekt melden. Weitere Informationen zum Erstellen einer öffentlichen Berichtsdefinition finden Sie in diesem Artikel.
ReportDefinitionPart	Berichtsdefinitionsteilobjekt.

CreateReportRequest

Objekt

Erstellen Sie berichtsanforderungsnutzlast.

Name	Typ	Beschreibung
definition	ReportDefinition	Die öffentliche Berichtsdefinition.
description	string	Die Berichtsbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der Anzeigename des Berichts. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
DataPipeline	Eine Datenpipeline.
Datamart	PowerBI datamart.
Environment	Eine Umgebung.
Eventhouse	Ein Eventhouse.
Eventstream	Ein Ereignisstream.
GraphQLApi	Eine API für GraphQL-Element.
KQLDashboard	Ein KQL-Dashboard.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
Lakehouse	Ein Seehaus.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
MirroredDatabase	Eine gespiegelte Datenbank.
MirroredWarehouse	Ein gespiegeltes Lager.
MountedDataFactory	Eine MountedDataFactory.
Notebook	Ein Notizbuch.
PaginatedReport	PowerBI-Paginated-Bericht.
Reflex	Ein Reflex.
Report	PowerBI-Bericht.
SQLDatabase	Eine SQLDatabase.
SQLEndpoint	Ein SQL-Endpunkt.
SemanticModel	PowerBI-Semantikmodell.
SparkJobDefinition	Eine Sparkauftragsdefinition.
Warehouse	Ein Lagerhaus.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

Report

Objekt

Ein Berichtsobjekt.

Name	Typ	Beschreibung
description	string	Die Elementbeschreibung.
displayName	string	Der Anzeigename des Elements.
id	string uuid	Die Element-ID.
type	ItemType	Der Elementtyp.
workspaceId	string uuid	Die Arbeitsbereichs-ID.

ReportDefinition

Objekt

Öffentliches Definitionsobjekt melden. Weitere Informationen zum Erstellen einer öffentlichen Berichtsdefinition finden Sie in diesem Artikel.

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition.
parts	ReportDefinitionPart[]	Eine Liste der Definitionsteile.

ReportDefinitionPart

Objekt

Berichtsdefinitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Berichtsteilpfad.
payload	string	Die Nutzlast des Berichtsteils.
payloadType	PayloadType	Der Nutzlasttyp.

Freigeben über

Items - Create Report

Erlaubnisse

Erforderliche delegierte Bereiche

Begrenzungen

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a report example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CreateReportRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PayloadType

Report

ReportDefinition

ReportDefinitionPart

Zusätzliche Ressourcen