Sdílet prostřednictvím

Items - Create Report

  • Reference
Služba:
Report
Verze rozhraní API:
v1

Vytvoří sestavu v zadaném pracovním prostoru.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Toto rozhraní API vyžaduje definici .

Dovolení

Volající musí mít roli přispěvatele nebo vyšší.

Požadované delegovaná rozsahy

Report.ReadWrite.All nebo Item.ReadWrite.All

Omezení

  • Aby uživatel mohl vytvořit položku sestavy, musí mít příslušnou licenci. Další informace naleznete v tématu: typy licencí Microsoft Fabric.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita Podpora
Uživatel Ano
instančního objektu a spravované identity Ano

Rozhraní

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
workspaceId
 path True

string

uuid

ID pracovního prostoru.

Text požadavku

Name Vyžadováno Typ Description
definition True

ReportDefinition

Veřejná definice sestavy.
displayName True

string

Zobrazovaný název sestavy. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
description

string

Popis sestavy. Maximální délka je 256 znaků.

Odpovědi

Name Typ Description
201 Created

Report

Úspěšně vytvořeno
202 Accepted

Žádost byla přijata a probíhá zřizování sestav.

Hlavičky

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

ErrorResponse

Běžné kódy chyb:

  • InvalidItemType – Typ položky je neplatný.

  • ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit.

  • Poškozená částPayload – zadanou datovou část je poškozena.

Příklady

Create a report example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
201 
{
  "displayName": "Report 1",
  "description": "A report description.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Stavový kód:
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

Definice

Name Description
CreateReportRequest

Vytvořte datovou část žádosti o sestavu.
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
ItemType

Typ položky. V průběhu času je možné přidat další typy položek.
PayloadType

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.
Report

Objekt sestavy.
ReportDefinition

Objekt veřejné definice sestavy Další podrobnosti o vytvoření veřejné definice sestavy najdete v tomto článku.
ReportDefinitionPart

Objekt části definice sestavy

CreateReportRequest

Objekt

Vytvořte datovou část žádosti o sestavu.

Name Typ Description
definition

ReportDefinition

Veřejná definice sestavy.
description

string

Popis sestavy. Maximální délka je 256 znaků.
displayName

string

Zobrazovaný název sestavy. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota Description
Dashboard

Řídicí panel PowerBI
DataPipeline

Datový kanál.
Datamart

Datový diagram PowerBI
Environment

Prostředí.
Eventhouse

Eventhouse.
Eventstream

Eventstream.
GraphQLApi

Rozhraní API pro položku GraphQL
KQLDashboard

Řídicí panel KQL.
KQLDatabase

Databáze KQL.
KQLQueryset

Sada dotazů KQL.
Lakehouse

Jezero.
MLExperiment

Experiment strojového učení.
MLModel

Model strojového učení.
MirroredDatabase

Zrcadlené databáze.
MirroredWarehouse

Zrcadlený sklad.
MountedDataFactory

A MountedDataFactory.
Notebook

Poznámkový blok.
PaginatedReport

Stránkovaná sestava PowerBI
Reflex

A Reflex.
Report

Sestava PowerBI
SQLDatabase

Databáze SQLDatabase.
SQLEndpoint

Koncový bod SQL.
SemanticModel

Sémantický model PowerBI
SparkJobDefinition

Definice úlohy Sparku.
Warehouse

Sklad.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota Description
InlineBase64

Vložená základna 64.

Report

Objekt

Objekt sestavy.

Name Typ Description
description

string

Popis položky.
displayName

string

Zobrazovaný název položky.
id

string

uuid

ID položky.
type

ItemType

Typ položky.
workspaceId

string

uuid

ID pracovního prostoru.

ReportDefinition

Objekt

Objekt veřejné definice sestavy Další podrobnosti o vytvoření veřejné definice sestavy najdete v tomto článku.

Name Typ Description
format

string

Formát definice položky.
parts

ReportDefinitionPart[]

Seznam částí definice.

ReportDefinitionPart

Objekt

Objekt části definice sestavy

Name Typ Description
path

string

Cesta části sestavy.
payload

string

Datová část sestavy.
payloadType

PayloadType

Typ datové části.