Items - Create Report

Odwołanie

Usługa:: Report

Wersja interfejsu API:: v1

Tworzy raport w określonym obszarze roboczym.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Ten interfejs API wymaga definicji .

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Report.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Aby utworzyć element raportu, użytkownik musi mieć odpowiednią licencję. Aby uzyskać więcej informacji, zobacz: typy licencji usługi Microsoft Fabric.

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
jednostki usługi i tożsamości zarządzanych	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string uuid	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Wymagane	Typ	Opis
definition	True	ReportDefinition	Definicja publiczna raportu.
displayName	True	string	Nazwa wyświetlana raportu. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.
description		string	Opis raportu. Maksymalna długość to 256 znaków.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Report	Pomyślnie utworzono
202 Accepted		Żądanie zaakceptowane, aprowizacja raportu jest w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — typ elementu jest nieprawidłowy. ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana. CorruptedPayload — podany ładunek jest uszkodzony.

Nazwa

Typ

Opis

201 Created

Report

Pomyślnie utworzono

202 Accepted

Żądanie zaakceptowane, aprowizacja raportu jest w toku.

Nagłówki

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

InvalidItemType — typ elementu jest nieprawidłowy.
ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana.
CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Create a report example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "Report 1",
  "description": "A report description.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod stanu:: 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

Definicje

Nazwa	Opis
CreateReportRequest	Utwórz ładunek żądania raportu.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
Report	Obiekt raportu.
ReportDefinition	Obiekt definicji publicznej raportu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej raportu.
ReportDefinitionPart	Obiekt części definicji raportu.

CreateReportRequest

Objekt

Utwórz ładunek żądania raportu.

Nazwa	Typ	Opis
definition	ReportDefinition	Definicja publiczna raportu.
description	string	Opis raportu. Maksymalna długość to 256 znaków.
displayName	string	Nazwa wyświetlana raportu. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ItemType

Wyliczanie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
DataPipeline	Potok danych.
Datamart	Datamart usługi Power BI.
Environment	Środowisko.
Eventhouse	Magazyn zdarzeń.
Eventstream	Strumień zdarzeń.
GraphQLApi	Interfejs API dla elementu GraphQL.
KQLDashboard	Pulpit nawigacyjny KQL.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
Lakehouse	Jezioro.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
MirroredDatabase	Dublowana baza danych.
MirroredWarehouse	Dublowany magazyn.
MountedDataFactory	A MountedDataFactory.
Notebook	Notes.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Reflex	Refleks.
Report	Raport usługi Power BI.
SQLDatabase	Baza danych SQLDatabase.
SQLEndpoint	Punkt końcowy SQL.
SemanticModel	Model semantyczny usługi PowerBI.
SparkJobDefinition	Definicja zadania platformy Spark.
Warehouse	Magazyn.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

Report

Objekt

Obiekt raportu.

Nazwa	Typ	Opis
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
id	string uuid	Identyfikator elementu.
type	ItemType	Typ elementu.
workspaceId	string uuid	Identyfikator obszaru roboczego.

ReportDefinition

Objekt

Obiekt definicji publicznej raportu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej raportu.

Nazwa	Typ	Opis
format	string	Format definicji elementu.
parts	ReportDefinitionPart[]	Lista części definicji.

ReportDefinitionPart

Objekt

Obiekt części definicji raportu.

Nazwa	Typ	Opis
path	string	Ścieżka części raportu.
payload	string	Ładunek części raportu.
payloadType	PayloadType	Typ ładunku.

Udostępnij za pośrednictwem

Items - Create Report

Uprawnienia

Wymagane zakresy delegowane

Ograniczenia

Tożsamości obsługiwane przez firmę Microsoft

Interfejs

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Create a report example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CreateReportRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PayloadType

Report

ReportDefinition

ReportDefinitionPart

Dodatkowe zasoby