Items - Create Report

Tjeneste:: Report

API-versjon:: v1

Oppretter en rapport i det angitte arbeidsområdet.
Denne API-en støtter langvarige operasjoner (LRO).

API-en definition støtter to opprettelsesmoduser: (1) gir full kontroll over rapportstrukturen, eller (2) gir en creationPayload for å opprette en semanticModelReference tom rapport som er koblet til en eksisterende semantisk modell. Enten definition eller creationPayload er nødvendig. Du kan ikke bruke begge samtidig.

Tillatelser

Innringeren må ha en rolle i arbeidsområdet for bidragsytere . Når du oppretter en rapport med en creationPayload som refererer til en semantisk modell via semanticModelReference, må innringeren også ha lesetilgang til den refererte semantiske modellen, inkludert når den semantiske modellen befinner seg i et annet arbeidsområde (referanse på tvers av arbeidsområder).

Nødvendige delegerte omfang

Report.ReadWrite.All eller Item.ReadWrite.All

Begrensninger

Hvis du vil opprette et rapportelement, må brukeren ha riktig lisens. Hvis du vil ha mer informasjon, kan du se: Microsoft Fabric lisenstyper.

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Name	Obligatorisk	Type	Beskrivelse
displayName	True	string	Visningsnavnet for rapporten. Visningsnavnet må følge navnereglene i henhold til elementtype.
creationPayload		ReportCreationPayload	Opprettingsnyttelasten for å opprette en rapport som er koblet til en eksisterende semantisk modell. Enten `definition` eller `creationPayload` er nødvendig. Du kan ikke bruke begge samtidig.
definition		ReportDefinition	Den offentlige definisjonen for rapporten. Enten `definition` eller `creationPayload` er nødvendig. Du kan ikke bruke begge samtidig.
description		string	Rapportbeskrivelsen. Maksimal lengde er 256 tegn.
folderId		string (uuid)	Mappe-ID-en. Hvis den ikke er angitt eller null, opprettes rapporten med arbeidsområdet som mappe.
sensitivityLabelSettings		SensitivityLabelSettings	Innstillingene for følsomhetsetiketten for rapporten.

Svar

Name	Type	Beskrivelse
201 Created	Report	Opprettet
202 Accepted		Forespørsel godtatt, rapportklargjøring pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: ItemDisplayNameAlreadyInUse – visningsnavnet for elementet er allerede brukt. CorruptedPayload – den angitte nyttelasten er skadet. MutuallyExclusiveProperties – og `definitioncreationPayload` kan ikke begge angis. MissingRequiredProperty – enten `definition` eller `creationPayload` må angis. SemanticModelNotFound – den refererte semantiske modellen finnes ikke eller er ikke tilgjengelig.

Eksempler

Create a report example

Create a report with creation payload example

Create a report example

Eksempelforespørsel

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

Eksempelsvar

Statuskode:: 201

{
  "displayName": "Report 1",
  "description": "A report description.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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

Create a report with creation payload example

Eksempelforespørsel

HTTP

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

{
  "displayName": "Sales Dashboard",
  "description": "An empty report connected to a semantic model.",
  "creationPayload": {
    "semanticModelReference": {
      "referenceType": "ById",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  }
}

Eksempelsvar

Statuskode:: 201

{
  "displayName": "Sales Dashboard",
  "description": "An empty report connected to a semantic model.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

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

Definisjoner

Name	Beskrivelse
CreateReportRequest	Opprett nyttelast for rapportforespørsel.
EntireTenantPrincipal	Representerer en leierkontohaver
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
GroupDetails	Grupper bestemte detaljer. Gjelder når hovedtypen er `Group`.
GroupPrincipal	Representerer en sikkerhetsgruppe.
GroupType	Typen gruppe. Flere gruppetyper kan legges til over tid.
ItemReferenceById	En elementreferanse av ID-objekt.
ItemReferenceType	Elementreferansetypen. Flere `ItemReferenceType` typer kan legges til over tid.
ItemTag	Representerer en kode som brukes på et element.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.
PrincipalType	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
Report	Et rapportobjekt.
ReportCreationPayload	Opprett nyttelast for å opprette en rapport uten en definisjon.
ReportDefinition	Offentlig rapportdefinisjonsobjekt. Se denne artikkelen for mer informasjon om strukturen i rapportdefinisjonen.
ReportDefinitionPart	Delobjekt for rapportdefinisjon.
SensitivityLabel	Representerer en følsomhetsetikett som brukes på et element.
SensitivityLabelApplyStrategy	Strategien for å bruke følsomhetsetiketten. Standardverdien er ApplyOrFail. Flere typer kan legges til over tid.
SensitivityLabelSettings	Innstillingene for følsomhetsetiketten.
ServicePrincipalDetails	Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Representerer en Microsoft Entra tjenestekontohaver.
ServicePrincipalProfileDetails	Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerer en tjenestekontohaverprofil.
UserDetails	Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er `User`.
UserPrincipal	Representerer en Microsoft Entra brukerkontohaver.

CreateReportRequest

Objekt

Opprett nyttelast for rapportforespørsel.

Name	Type	Beskrivelse
creationPayload	ReportCreationPayload	Opprettingsnyttelasten for å opprette en rapport som er koblet til en eksisterende semantisk modell. Enten `definition` eller `creationPayload` er nødvendig. Du kan ikke bruke begge samtidig.
definition	ReportDefinition	Den offentlige definisjonen for rapporten. Enten `definition` eller `creationPayload` er nødvendig. Du kan ikke bruke begge samtidig.
description	string	Rapportbeskrivelsen. Maksimal lengde er 256 tegn.
displayName	string	Visningsnavnet for rapporten. Visningsnavnet må følge navnereglene i henhold til elementtype.
folderId	string (uuid)	Mappe-ID-en. Hvis den ikke er angitt eller null, opprettes rapporten med arbeidsområdet som mappe.
sensitivityLabelSettings	SensitivityLabelSettings	Innstillingene for følsomhetsetiketten for rapporten.

EntireTenantPrincipal

Objekt

Representerer en leierkontohaver

Name	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
type	string: EntireTenant	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

GroupDetails

Objekt

Grupper bestemte detaljer. Gjelder når hovedtypen er Group.

Name	Type	Beskrivelse
groupType	GroupType	Typen gruppe. Flere gruppetyper kan legges til over tid.

GroupPrincipal

Objekt

Representerer en sikkerhetsgruppe.

Name	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
groupDetails	GroupDetails	Grupper bestemte detaljer. Gjelder når hovedtypen er `Group`.
id	string (uuid)	Hovedkontohaverens ID.
type	string: Group	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

GroupType

Opplisting

Typen gruppe. Flere gruppetyper kan legges til over tid.

Verdi	Beskrivelse
Unknown	Hovedgruppetypen er ukjent.
SecurityGroup	Hovedstol er en sikkerhetsgruppe.
DistributionList	Hovedstol er en distribusjonsliste.

ItemReferenceById

Objekt

En elementreferanse av ID-objekt.

Name	Type	Beskrivelse
itemId	string (uuid)	ID-en for elementet.
referenceType	string: ById	Elementreferansetypen.
workspaceId	string (uuid)	Arbeidsområde-ID-en for elementet.

ItemReferenceType

Opplisting

Elementreferansetypen. Flere ItemReferenceType typer kan legges til over tid.

Verdi	Beskrivelse
ById	Elementet refereres av ID-en.
ByVariable	Elementet refereres av en variabel.

ItemTag

Objekt

Representerer en kode som brukes på et element.

Name	Type	Beskrivelse
displayName	string	Navnet på koden.
id	string (uuid)	Kode-ID-en.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-modell.
PaginatedReport	Paginert powerbi-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et innsjøhus.
Eventhouse	Et arrangementshus.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
KQLDashboard	Et KQL-instrumentbord.
DataPipeline	Et datasamlebånd.
Notebook	En notatblokk.
SparkJobDefinition	En spark-jobbdefinisjon.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
Warehouse	Et lager.
Eventstream	En hendelsesstrøm.
SQLEndpoint	Et SQL-endepunkt.
MirroredWarehouse	Et speilvendt lager.
MirroredDatabase	En speilvendt database.
Reflex	En refleks.
GraphQLApi	En API for GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	En kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	En dataflyt.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et øyeblikksbilde av lageret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	En digital Twin Builder-flyt.
MirroredAzureDatabricksCatalog	En speilet azure databricks-katalog.
Map	Et kart.
AnomalyDetector	En avviksdetektor.
UserDataFunction	En brukerdatafunksjon.
GraphModel	En GraphModel.
GraphQuerySet	Et graph QuerySet.
SnowflakeDatabase	En Snowflake Database for å lagre Iceberg-tabeller opprettet fra Snowflake-kontoen.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaset.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.
PolicySet	Et policysett.
AppBackend	En AppBackend.
OrgApp	En organisasjonsapp.
OrgAppAudience	En organisasjonsapp målgruppe.
DataBuildToolJob	En DataBuildToolJob.
AzureDatabricksStorage	Et OneLake-støttet lagringselement for Azure Databricks.
Plan	En plan.
Monitoring	Et overvåkingselement.
DeploymentPlan	En distribusjonsplan.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.

PrincipalType

Opplisting

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

Verdi	Beskrivelse
User	Hovedstol er en Microsoft Entra brukerkontohaver.
ServicePrincipal	Principal er en Microsoft Entra tjenestekontohaver.
Group	Hovedstol er en sikkerhetsgruppe.
ServicePrincipalProfile	Principal er en tjenestekontohaverprofil.
EntireTenant	Hovedstol representerer alle leierbrukere.

Report

Objekt

Et rapportobjekt.

Name	Type	Beskrivelse
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Elementets standardidentitet.
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
folderId	string (uuid)	Mappe-ID-en.
id	string (uuid)	Element-ID-en.
logicalId	string (uuid)	Elementets logiske identifikator. Tilsvarende elementforekomster deler samme logiske ID. Verdien er null når ingen logisk ID er tilordnet.
sensitivityLabel	SensitivityLabel	Elementfølsomhetsetiketten.
tags	ItemTag[]	Liste over brukte merker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbeidsområde-ID-en.

ReportCreationPayload

Objekt

Opprett nyttelast for å opprette en rapport uten en definisjon.

Name	Type	Beskrivelse
semanticModelReference	ItemReferenceById	En referanse til den semantiske modellen som rapporten skal kobles til. Den semantiske modellen må være tilgjengelig for innringeren.

ReportDefinition

Objekt

Offentlig rapportdefinisjonsobjekt. Se denne artikkelen for mer informasjon om strukturen i rapportdefinisjonen.

Name	Type	Beskrivelse
format	string	Formatet for rapportdefinisjonen.
parts	ReportDefinitionPart[]	En liste over definisjonsdeler.

ReportDefinitionPart

Objekt

Delobjekt for rapportdefinisjon.

Name	Type	Beskrivelse
path	string	Rapportdelbanen.
payload	string	Nyttelasten for rapportdelen.
payloadType	PayloadType	Nyttelasttypen.

SensitivityLabel

Objekt

Representerer en følsomhetsetikett som brukes på et element.

Name	Type	Beskrivelse
id	string (uuid)	Følsomhetsetikett-ID-en.

SensitivityLabelApplyStrategy

Opplisting

Strategien for å bruke følsomhetsetiketten. Standardverdien er ApplyOrFail. Flere typer kan legges til over tid.

Verdi	Beskrivelse
ApplyOrFail	Bruk følsomhetsetiketten eller mislykke operasjonen hvis den ikke kan brukes.
Ignore	Ignorer følsomhetsetiketten hvis den ikke kan brukes, og fortsett med operasjonen uten å bruke etiketten.

SensitivityLabelSettings

Objekt

Innstillingene for følsomhetsetiketten.

Name	Type	Beskrivelse
labelId	string (uuid)	Følsomhetsetikett-ID-en.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategien for å bruke følsomhetsetiketten.

ServicePrincipalDetails

Objekt

Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er ServicePrincipal.

Name	Type	Beskrivelse
aadAppId	string (uuid)	Tjenestekontohaverens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerer en Microsoft Entra tjenestekontohaver.

Name	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
servicePrincipalDetails	ServicePrincipalDetails	Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ServicePrincipalProfileDetails

Objekt

Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er ServicePrincipalProfile.

Name	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Overordnet hovedkontohaver for tjenestekontohaverprofilen.

ServicePrincipalProfilePrincipal

Objekt

Representerer en tjenestekontohaverprofil.

Name	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

UserDetails

Objekt

Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er User.

Name	Type	Beskrivelse
userPrincipalName	string	Brukerhovednavn.

UserPrincipal

Objekt

Representerer en Microsoft Entra brukerkontohaver.

Name	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
type	string: User	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
userDetails	UserDetails	Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er `User`.