Items - Create Report

Palvelu:: Report

Ohjelmointirajapinnan versio:: v1

Luo raportin määritettyyn työtilaan.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

-ohjelmointirajapinta tukee kahta luontitilaa: (1) mahdollistaa definition raporttirakenteen täydellisen hallinnan, tai (2) tarjoaa creationPayload -toiminnon, jolla semanticModelReference luodaan tyhjä raportti, joka on yhdistetty aiemmin luotuun semanttiseen malliin. Joko definition tai creationPayload on pakollinen. Molempia ei voi käyttää samanaikaisesti.

Käyttöoikeudet

Kutsujalla on oltava osallistujan työtilan rooli. Kun luot raportin, jossa creationPayload on viittaus semanttiseen malliin :n kautta semanticModelReference, kutsujalla on myös oltava lukuoikeus viitattuun semanttiseen malliin myös silloin, kun kyseinen semanttinen malli sijaitsee eri työtilassa (työtilojen välinen viittaus).

Vaaditut delegoidut vaikutusalueet

Report.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Jotta käyttäjä voi luoda raporttikohteen, hänellä on oltava asianmukainen käyttöoikeus. Lisätietoja on artikkelissa Microsoft Fabric-käyttöoikeustyypit.

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft identities.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
displayName	True	string	Raportin näyttönimi. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
creationPayload		ReportCreationPayload	Luonnin hyötykuorma aiemmin luotuun semanttiseen malliin yhdistetyn raportin luomista varten. Joko `definition` tai `creationPayload` on pakollinen. Molempia ei voi käyttää samanaikaisesti.
definition		ReportDefinition	Raportin julkinen määritys. Joko `definition` tai `creationPayload` on pakollinen. Molempia ei voi käyttää samanaikaisesti.
description		string	Raportin kuvaus. Enimmäispituus on 256 merkkiä.
folderId		string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvoinen, raportti luodaan siten, että työtila on sen kansio.
sensitivityLabelSettings		SensitivityLabelSettings	Raportin luottamuksellisuustunnisteen asetukset.

Vastaukset

Nimi	Tyyppi	Kuvaus
201 Created	Report	Luonti onnistui
202 Accepted		Pyyntö hyväksytty, raportin valmistelu on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä. VioittunutPayload – Annetut tiedot ovat vioittuneet. MutuallyExclusiveProperties – Ja `definitioncreationPayload` niitä molempia ei voi antaa. MissingRequiredProperty – Joko `definition` tai `creationPayload` täytyy antaa. SemanticModelNotFound: Viitausta semanttisesta mallista ei ole olemassa tai sitä ei voi käyttää.

Esimerkit

Create a report example

Create a report with creation payload example

Create a report example

Mallipyyntö

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

Mallivastaus

Tilakoodi:: 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"
  }
}

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

Mallipyyntö

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

Mallivastaus

Tilakoodi:: 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"
}

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

Määritelmät

Nimi	Kuvaus
CreateReportRequest	Raporttipyyntöjen tietojen luominen.
EntireTenantPrincipal	Edustaa vuokraajan päänimeä
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
GroupPrincipal	Edustaa käyttöoikeusryhmää.
GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.
ItemReferenceById	Kohdeviittaus tunnusobjektin mukaan.
ItemReferenceType	Kohteen viittaustyyppi. Muita `ItemReferenceType` tyyppejä voidaan lisätä ajan kuluessa.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
PrincipalType	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
Report	Raporttiobjekti.
ReportCreationPayload	Luo tiedot raportin luomiseksi ilman määritelmää.
ReportDefinition	Raportin julkisen määrityksen objekti. Katso tästä artikkelista lisätietoja raportin määrityksen rakenteesta.
ReportDefinitionPart	Raportin määritysosan objekti.
SensitivityLabel	Edustaa kohteelle käytettyä luottamuksellisuustunnistetta.
SensitivityLabelApplyStrategy	Tämä on luottamuksellisuustunnisteen käyttöön tarkoitettu strategia. Oletusarvo on ApplyOrFail. Muita tyyppejä voidaan lisätä ajan mittaan.
SensitivityLabelSettings	Luottamuksellisuustunnisteen asetukset.
ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
ServicePrincipalPrincipal	Ilmaisee Microsoft Entra palvelun päänimen.
ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Edustaa palvelun pääprofiilia.
UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.
UserPrincipal	Edustaa Microsoft Entra käyttäjäobjektia.

CreateReportRequest

Kohde

Raporttipyyntöjen tietojen luominen.

Nimi	Tyyppi	Kuvaus
creationPayload	ReportCreationPayload	Luonnin hyötykuorma aiemmin luotuun semanttiseen malliin yhdistetyn raportin luomista varten. Joko `definition` tai `creationPayload` on pakollinen. Molempia ei voi käyttää samanaikaisesti.
definition	ReportDefinition	Raportin julkinen määritys. Joko `definition` tai `creationPayload` on pakollinen. Molempia ei voi käyttää samanaikaisesti.
description	string	Raportin kuvaus. Enimmäispituus on 256 merkkiä.
displayName	string	Raportin näyttönimi. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
folderId	string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvoinen, raportti luodaan siten, että työtila on sen kansio.
sensitivityLabelSettings	SensitivityLabelSettings	Raportin luottamuksellisuustunnisteen asetukset.

EntireTenantPrincipal

Kohde

Edustaa vuokraajan päänimeä

Nimi	Tyyppi	Kuvaus
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
type	string: EntireTenant	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GroupDetails

Kohde

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.

Nimi	Tyyppi	Kuvaus
groupType	GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

GroupPrincipal

Kohde

Edustaa käyttöoikeusryhmää.

Nimi	Tyyppi	Kuvaus
displayName	string	Tämä on päänimen näyttönimi.
groupDetails	GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
id	string (uuid)	Päänimen tunnus.
type	string: Group	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

GroupType

Luettelointi

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Unknown	Pääryhmän tyyppi on tuntematon.
SecurityGroup	Principal on käyttöoikeusryhmä.
DistributionList	Principal on jakeluluettelo.

ItemReferenceById

Kohde

Kohdeviittaus tunnusobjektin mukaan.

Nimi	Tyyppi	Kuvaus
itemId	string (uuid)	Kohteen tunnus.
referenceType	string: ById	Kohteen viittaustyyppi.
workspaceId	string (uuid)	Kohteen työtilan tunnus.

ItemReferenceType

Luettelointi

Kohteen viittaustyyppi. Muita ItemReferenceType tyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
ById	Kohteeseen viitataan sen tunnuksella.
ByVariable	Muuttuja viittaa kohteeseen.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Kuvaus
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
PolicySet	Käytäntöjoukko.
AppBackend	An AppBackend.
OrgApp	Organisaatiosovellus.
OrgAppAudience	An Org App Audience.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	OneLake-taustainen tallennuskohde Azure Databricks.
Plan	Suunnitelma.
Monitoring	Valvontakohde.
DeploymentPlan	Käyttöönottosuunnitelma.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
InlineBase64	Inline Base 64.

PrincipalType

Luettelointi

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
User	Principal on Microsoft Entra käyttäjäobjekti.
ServicePrincipal	Principal on Microsoft Entra palvelun päänimi.
Group	Principal on käyttöoikeusryhmä.
ServicePrincipalProfile	Principal on palvelun pääprofiili.
EntireTenant	Principal edustaa kaikkia vuokraajan käyttäjiä.

Report

Kohde

Raporttiobjekti.

Nimi	Tyyppi	Kuvaus
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Kohteen oletusarvoiset käyttäjätiedot.
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
logicalId	string (uuid)	Kohteen looginen tunniste. Vastaavilla kohdeesiintymillä on sama looginen tunnus. Arvo on tyhjäarvo, kun loogista tunnusta ei ole määritetty.
sensitivityLabel	SensitivityLabel	Kohteen luottamuksellisuustunniste.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

ReportCreationPayload

Kohde

Luo tiedot raportin luomiseksi ilman määritelmää.

Nimi	Tyyppi	Kuvaus
semanticModelReference	ItemReferenceById	Viittaus semanttiseen malliin, johon raportti yhdistetään. Semanttisen mallin on oltava soittajan käytettävissä.

ReportDefinition

Kohde

Raportin julkisen määrityksen objekti. Katso tästä artikkelista lisätietoja raportin määrityksen rakenteesta.

Nimi	Tyyppi	Kuvaus
format	string	Raportin määrityksen muoto.
parts	ReportDefinitionPart[]	Luettelo määritysosista.

ReportDefinitionPart

Kohde

Raportin määritysosan objekti.

Nimi	Tyyppi	Kuvaus
path	string	Raporttiosan polku.
payload	string	Raportin osakuormitus.
payloadType	PayloadType	Hyötykuorman tyyppi.

SensitivityLabel

Kohde

Edustaa kohteelle käytettyä luottamuksellisuustunnistetta.

Nimi	Tyyppi	Kuvaus
id	string (uuid)	Tämä on luottamuksellisuustunnisteen tunnus.

SensitivityLabelApplyStrategy

Luettelointi

Tämä on luottamuksellisuustunnisteen käyttöön tarkoitettu strategia. Oletusarvo on ApplyOrFail. Muita tyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
ApplyOrFail	Käytä luottamuksellisuustunnistetta tai epäonnistu toiminto, jos sitä ei voi käyttää.
Ignore	Ohita luottamuksellisuustunniste, jos sitä ei voi käyttää, ja jatka toiminnolla ilman tunnisteen käyttämistä.

SensitivityLabelSettings

Kohde

Luottamuksellisuustunnisteen asetukset.

Nimi	Tyyppi	Kuvaus
labelId	string (uuid)	Tämä on luottamuksellisuustunnisteen tunnus.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Tämä on luottamuksellisuustunnisteen käyttöön tarkoitettu strategia.

ServicePrincipalDetails

Kohde

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.

Nimi	Tyyppi	Kuvaus
aadAppId	string (uuid)	Palvelun päänimen Microsoft Entra AppId.

ServicePrincipalPrincipal

Kohde

Ilmaisee Microsoft Entra palvelun päänimen.

Nimi	Tyyppi	Kuvaus
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
servicePrincipalDetails	ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
type	string: ServicePrincipal	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ServicePrincipalProfileDetails

Kohde

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.

Nimi	Tyyppi	Kuvaus
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Palvelun pääprofiilin pääobjekti.

ServicePrincipalProfilePrincipal

Kohde

Edustaa palvelun pääprofiilia.

Nimi	Tyyppi	Kuvaus
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

UserDetails

Kohde

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

Nimi	Tyyppi	Kuvaus
userPrincipalName	string	Täydellinen käyttäjänimi.

UserPrincipal

Kohde

Edustaa Microsoft Entra käyttäjäobjektia.

Nimi	Tyyppi	Kuvaus
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
type	string: User	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
userDetails	UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.