Delen via

Items - Create Report

  • Referentie
Service:
Report
API-versie:
v1

Hiermee maakt u een rapport in de opgegeven werkruimte.
Deze API ondersteunt langlopende bewerkingen (LRO).

Voor deze API is een definitievereist.

Machtigingen

De aanroeper moet inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Report.ReadWrite.All of Item.ReadWrite.All

Beperkingen

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit Steunen
Gebruiker Ja
service-principal en beheerde identiteiten Ja

Interface

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

URI-parameters

Name In Vereist Type Description
workspaceId
 path True

string

uuid

De werkruimte-id.

Aanvraagbody

Name Vereist Type Description
definition True

ReportDefinition

De openbare definitie van het rapport.
displayName True

string

De weergavenaam van het rapport. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype.
description

string

De beschrijving van het rapport. De maximale lengte is 256 tekens.

Antwoorden

Name Type Description
201 Created

Report

Gemaakt
202 Accepted

Aanvraag geaccepteerd, inrichting rapporteren wordt uitgevoerd.

Kopteksten

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • InvalidItemType - Itemtype is ongeldig.

  • ItemDisplayNameAlreadyInUse - Weergavenaam van item wordt al gebruikt.

  • CorruptedPayload: de opgegeven nettolading is beschadigd.

Voorbeelden

Create a report example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CreateReportRequest

Nettolading van rapportaanvraag maken.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
PayloadType

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
Report

Een rapportobject.
ReportDefinition

Openbaar definitieobject rapporteren. Raadpleeg dit artikel voor meer informatie over het maken van een openbare rapportdefinitie.
ReportDefinitionPart

Rapportdefinitieonderdeelobject.

CreateReportRequest

Object

Nettolading van rapportaanvraag maken.

Name Type Description
definition

ReportDefinition

De openbare definitie van het rapport.
description

string

De beschrijving van het rapport. De maximale lengte is 256 tekens.
displayName

string

De weergavenaam van het rapport. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

ItemType

Inventarisatie

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
DataPipeline

Een gegevenspijplijn.
Datamart

PowerBI-datamart.
Environment

Een omgeving.
Eventhouse

Een eventhouse.
Eventstream

Een eventstream.
GraphQLApi

Een API voor GraphQL-item.
KQLDashboard

Een KQL-dashboard.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
Lakehouse

Een lakehouse.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
MirroredDatabase

Een gespiegelde database.
MirroredWarehouse

Een gespiegeld magazijn.
MountedDataFactory

Een MountedDataFactory.
Notebook

Een notitieblok.
PaginatedReport

Gepagineerd Power BI-rapport.
Reflex

Een reflex.
Report

PowerBI-rapport.
SQLDatabase

Een SQLDatabase.
SQLEndpoint

Een SQL-eindpunt.
SemanticModel

Semantisch Power BI-model.
SparkJobDefinition

Een Spark-taakdefinitie.
Warehouse

Een magazijn.

PayloadType

Inventarisatie

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde Description
InlineBase64

Inline base 64.

Report

Object

Een rapportobject.

Name Type Description
description

string

De beschrijving van het item.
displayName

string

De weergavenaam van het item.
id

string

uuid

De item-id.
type

ItemType

Het itemtype.
workspaceId

string

uuid

De werkruimte-id.

ReportDefinition

Object

Openbaar definitieobject rapporteren. Raadpleeg dit artikel voor meer informatie over het maken van een openbare rapportdefinitie.

Name Type Description
format

string

De indeling van de itemdefinitie.
parts

ReportDefinitionPart[]

Een lijst met definitieonderdelen.

ReportDefinitionPart

Object

Rapportdefinitieonderdeelobject.

Name Type Description
path

string

Het pad naar het rapportonderdeel.
payload

string

De nettolading van het rapportonderdeel.
payloadType

PayloadType

Het nettoladingstype.