Udostępnij przez

Items - Get Report Definition

Usługa:
Report
Wersja interfejsu API:
v1

Zwraca określoną definicję publiczną raportu.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Gdy uzyskasz publiczną definicję raportu, etykieta poufności nie jest częścią definicji.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla raportu.

Wymagane zakresy delegowane

Report.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Ten interfejs API jest blokowany dla raportu z zaszyfrowaną etykietą poufności.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
reportId
 path True

string (uuid)

Identyfikator raportu.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Odpowiedzi

Nazwa Typ Opis
200 OK

ReportDefinitionResponse

Żądanie zostało ukończone pomyślnie.
202 Accepted

Zaakceptowano żądanie. Pobieranie definicji jest w toku.

Nagłówki

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

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

Przykłady

Get a report definition example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Przykładowa odpowiedź

Kod stanu:
200 
{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Kod stanu:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definicje

Nazwa Opis
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
PayloadType

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
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.
ReportDefinitionResponse

Odpowiedź na definicję publiczną raportu.

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.

PayloadType

Wyliczanie

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

Wartość Opis
InlineBase64

Śródliniowa baza 64.

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.

ReportDefinitionResponse

Objekt

Odpowiedź na definicję publiczną raportu.

Nazwa Typ Opis
definition

ReportDefinition

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