Items - Create Report

Vytvorí zostavu v zadanom pracovnom priestore.
Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Toto rozhranie API vyžaduje definíciu.

Povolenia

Volajúci musí mať rolu pracovného priestoru prispievateľa .

Povinné delegované rozsahy

Report.ReadWrite.All alebo Item.ReadWrite.All

Obmedzenia

  • Ak chcete vytvoriť položku zostavy, používateľ musí mať príslušnú licenciu. Ďalšie informácie nájdete v téme: Microsoft Fabric typy licencií.

podporované identity Microsoft Entra

Toto rozhranie API podporuje Microsoft identity uvedené v tejto časti.

Identita Podpora
Používateľ Áno
Objekt služby a spravované identity Áno

Rozhranie

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

Parametre URI

Name V Povinné Typ Description
workspaceId
path True

string (uuid)

ID pracovného priestoru.

Text požiadavky

Name Povinné Typ Description
definition True

ReportDefinition

Verejná definícia zostavy.

displayName True

string

Zobrazovaný názov zostavy. Zobrazovaný názov musí postupovať podľa pravidiel pomenovania podľa typu položky.

description

string

Popis zostavy. Maximálna dĺžka je 256 znakov.

folderId

string (uuid)

ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa zostava s pracovným priestorom ako priečinkom.

sensitivityLabelSettings

SensitivityLabelSettings

Nastavenia označenia citlivosti pre zostavu.

Odpovede

Name Typ Description
201 Created

Report

Úspešne vytvorené

202 Accepted

Žiadosť prijatá, prebieha poskytovanie zostáv.

Hlavičky

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Bežné kódy chýb:

  • InvalidItemType – typ položky je neplatný.

  • ItemDisplayNameAlreadyInUse – zobrazovaný názov položky sa už používa.

  • CorruptedPayload – poskytnutá údajová časť je poškodená.

  • Limit položiek pracovného priestoruItemsLimitExceeded – limit položiek pracovného priestoru bol prekročený.

Príklady

Create a report example

Vzorová požiadavka

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

Vzorová odpoveď

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

Definície

Name Description
CreateReportRequest

Vytvorte údajovú časť žiadosti o zostavu.

EntireTenantPrincipal

Predstavuje objekt nájomníka

ErrorRelatedResource

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

ErrorResponse

Odpoveď na chybu.

ErrorResponseDetails

Podrobnosti o chybovej odpovedi.

GroupDetails

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

GroupPrincipal

Predstavuje skupinu zabezpečenia.

GroupType

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

ItemTag

Predstavuje značku použitú na položke.

ItemType

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

PayloadType

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

PrincipalType

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Report

Objekt zostavy.

ReportDefinition

Objekt verejnej definície zostavy. Ďalšie podrobnosti o štruktúre definície zostavy nájdete v tomto článku .

ReportDefinitionPart

Časť objektu definície zostavy.

SensitivityLabel

Predstavuje označenie citlivosti použité na položku.

SensitivityLabelApplyStrategy

Stratégia používania označenia citlivosti. Predvolená hodnota je ApplyOrFail. V priebehu času je možné pridať ďalšie typy.

SensitivityLabelSettings

Nastavenia označenia citlivosti.

ServicePrincipalDetails

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

ServicePrincipalPrincipal

Predstavuje Microsoft Entra objekt služby.

ServicePrincipalProfileDetails

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

ServicePrincipalProfilePrincipal

Predstavuje profil objektu služby.

UserDetails

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

UserPrincipal

Predstavuje Microsoft Entra hlavného používateľa.

CreateReportRequest

Vytvorte údajovú časť žiadosti o zostavu.

Name Typ Description
definition

ReportDefinition

Verejná definícia zostavy.

description

string

Popis zostavy. Maximálna dĺžka je 256 znakov.

displayName

string

Zobrazovaný názov zostavy. Zobrazovaný názov musí postupovať podľa pravidiel pomenovania podľa typu položky.

folderId

string (uuid)

ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa zostava s pracovným priestorom ako priečinkom.

sensitivityLabelSettings

SensitivityLabelSettings

Nastavenia označenia citlivosti pre zostavu.

EntireTenantPrincipal

Predstavuje objekt nájomníka

Name Typ Description
displayName

string

Zobrazovaný názov objektu.

id

string (uuid)

ID objektu.

type string:

EntireTenant

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ErrorRelatedResource

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name Typ Description
resourceId

string

ID prostriedku, ktoré je súčasťou chyby.

resourceType

string

Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Odpoveď na chybu.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.

isRetriable

boolean

Ak je hodnota true, žiadosť sa môže zopakovať. Retry-After Ak je k dispozícii, oneskorenie môžete určiť pomocou hlavičky odpovede.

message

string

Zobrazenie chyby čitateľné ľuďmi.

moreDetails

ErrorResponseDetails[]

Zoznam ďalších podrobností o chybe.

relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.

requestId

string (uuid)

ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Podrobnosti o chybovej odpovedi.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.

message

string

Zobrazenie chyby čitateľné ľuďmi.

relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.

GroupDetails

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Name Typ Description
groupType

GroupType

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupPrincipal

Predstavuje skupinu zabezpečenia.

Name Typ Description
displayName

string

Zobrazovaný názov objektu.

groupDetails

GroupDetails

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

id

string (uuid)

ID objektu.

type string:

Group

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

GroupType

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota Description
Unknown

Typ hlavnej skupiny nie je známy.

SecurityGroup

Principal je skupina zabezpečenia.

DistributionList

Principal je distribučný zoznam.

ItemTag

Predstavuje značku použitú na položke.

Name Typ Description
displayName

string

Názov značky.

id

string (uuid)

ID značky.

ItemType

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota Description
Dashboard

Tabuľa služby PowerBI.

Report

Zostava PowerBI.

SemanticModel

Sémantický model PowerBI.

PaginatedReport

Stránkovaná zostava služby PowerBI.

Datamart

Údajový diagram služby PowerBI.

Lakehouse

Jazero.

Eventhouse

Eventhouse.

Environment

Prostredie.

KQLDatabase

Databáza KQL.

KQLQueryset

Množina dotazov KQL.

KQLDashboard

Tabuľa KQL.

DataPipeline

Kanál údajov.

Notebook

Poznámkový blok.

SparkJobDefinition

Definícia úlohy iskry.

MLExperiment

Experiment strojového učenia.

MLModel

Model strojového učenia.

Warehouse

Sklad.

Eventstream

Udalosť eventstream.

SQLEndpoint

Koncový bod SQL.

MirroredWarehouse

Zrkadlový sklad.

MirroredDatabase

Zrkadlová databáza.

Reflex

A Reflex.

GraphQLApi

Rozhranie API pre položku GraphQL.

MountedDataFactory

A MountedDataFactory.

SQLDatabase

Databáza SQLDatabase.

CopyJob

Kopírovať úlohu.

VariableLibrary

A VariableLibrary.

Dataflow

Tok údajov.

ApacheAirflowJob

An ApacheAirflowJob.

WarehouseSnapshot

Snímka skladu.

DigitalTwinBuilder

A DigitalTwinBuilder.

DigitalTwinBuilderFlow

Digitálny postup Twin Buildera.

MirroredAzureDatabricksCatalog

Zrkadlový katalóg Azure databricks.

Map

Mapa.

AnomalyDetector

Detektor anomálií.

UserDataFunction

Funkcia user data function.

GraphModel

A GraphModel.

GraphQuerySet

Množina dotazov Graphu.

SnowflakeDatabase

Databáza Snowflake na ukladanie tabuliek ľadovec vytvorených z konta Snowflake.

OperationsAgent

OperationsAgent (Operácia).

CosmosDBDatabase

Databáza Cosmos DB.

Ontology

Ontológia.

EventSchemaSet

Množina schém udalosti.

DataAgent

DataAgent (Údajovýgens).

MirroredCatalog

Zrkadlovýcatalog.

AppBackend

An AppBackend.

PayloadType

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

Hodnota Description
InlineBase64

Inline Base 64.

PrincipalType

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota Description
User

Principal je Microsoft Entra objektom používateľa.

ServicePrincipal

Principal je Microsoft Entra objekt služby.

Group

Principal je skupina zabezpečenia.

ServicePrincipalProfile

Principal je profil objektu služby.

EntireTenant

Možnosť Principal predstavuje všetkých používateľov nájomníka.

Report

Objekt zostavy.

Name Typ Description
defaultIdentity Principal:

Predvolená identita položky.

description

string

Popis položky.

displayName

string

Zobrazovaný názov položky.

folderId

string (uuid)

ID priečinka.

id

string (uuid)

ID položky.

sensitivityLabel

SensitivityLabel

Označenie citlivosti položky.

tags

ItemTag[]

Zoznam použitých značiek.

type

ItemType

Typ položky.

workspaceId

string (uuid)

ID pracovného priestoru.

ReportDefinition

Objekt verejnej definície zostavy. Ďalšie podrobnosti o štruktúre definície zostavy nájdete v tomto článku .

Name Typ Description
format

string

Formát definície zostavy.

parts

ReportDefinitionPart[]

Zoznam častí definície.

ReportDefinitionPart

Časť objektu definície zostavy.

Name Typ Description
path

string

Cesta k časti zostavy.

payload

string

Údajová časť zostavy.

payloadType

PayloadType

Typ údajovej časti.

SensitivityLabel

Predstavuje označenie citlivosti použité na položku.

Name Typ Description
id

string (uuid)

ID označenia citlivosti.

SensitivityLabelApplyStrategy

Stratégia používania označenia citlivosti. Predvolená hodnota je ApplyOrFail. V priebehu času je možné pridať ďalšie typy.

Hodnota Description
ApplyOrFail

Použite označenie citlivosti alebo zlyhajte operáciu, ak sa nedá použiť.

Ignore

Ignorujte označenie citlivosti, ak ho nie je možné použiť a pokračovať s operáciou bez použitia označenia.

SensitivityLabelSettings

Nastavenia označenia citlivosti.

Name Typ Description
labelId

string (uuid)

ID označenia citlivosti.

sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Stratégia používania označenia citlivosti.

ServicePrincipalDetails

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Name Typ Description
aadAppId

string (uuid)

Microsoft Entra id objektu služby.

ServicePrincipalPrincipal

Predstavuje Microsoft Entra objekt služby.

Name Typ Description
displayName

string

Zobrazovaný názov objektu.

id

string (uuid)

ID objektu.

servicePrincipalDetails

ServicePrincipalDetails

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

type string:

ServicePrincipal

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ServicePrincipalProfileDetails

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Name Typ Description
parentPrincipal Principal:

Nadradený objekt profilu služby.

ServicePrincipalProfilePrincipal

Predstavuje profil objektu služby.

Name Typ Description
displayName

string

Zobrazovaný názov objektu.

id

string (uuid)

ID objektu.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

type string:

ServicePrincipalProfile

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

UserDetails

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Name Typ Description
userPrincipalName

string

Hlavné meno používateľa.

UserPrincipal

Predstavuje Microsoft Entra hlavného používateľa.

Name Typ Description
displayName

string

Zobrazovaný názov objektu.

id

string (uuid)

ID objektu.

type string:

User

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

userDetails

UserDetails

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .