Imports - Get Import

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Zwraca określony import z Mój obszar roboczy.

Wymagany zakres

Dataset.ReadWrite.All lub Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/imports/{importId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
importId	path	True	string (uuid)	Identyfikator importu

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Import	OK

Przykłady

Completed import example

In-progress import example

Completed import example

Przykładowe zapytanie

GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
  "importState": "Succeeded",
  "createdDateTime": "2018-05-08T14:56:18.477Z",
  "updatedDateTime": "2018-05-08T14:56:18.477Z",
  "name": "SalesMarketing",
  "connectionType": "import",
  "source": "Upload",
  "datasets": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ],
  "reports": [
    {
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

In-progress import example

Przykładowe zapytanie

GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
  "importState": "Publishing",
  "createdDateTime": "2018-05-08T14:56:18.477Z",
  "updatedDateTime": "2018-05-08T14:56:18.477Z",
  "name": "SalesMarketing",
  "connectionType": "import",
  "source": "Upload",
  "datasets": [],
  "reports": []
}

Definicje

Nazwa	Opis
Dataset	Zestaw danych usługi Power BI. Interfejs API zwraca podzbiór poniższych właściwości zestawu danych. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.
DatasetQueryScaleOutSettings	Ustawienia skalowania zapytań w poziomie zestawu danych
DatasetUser	Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych
DatasetUserAccessRight	Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień)
DependentDataflow	Zależny przepływ danych usługi Power BI
Encryption	Informacje o szyfrowaniu zestawu danych
EncryptionStatus	Stan szyfrowania zestawu danych
Import	Obiekt importu
PrincipalType	Typ podmiotu zabezpieczeń
Report	Raport usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości raportu. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.
ReportUser	Wpis prawa dostępu użytkownika usługi Power BI dla raportu
ReportUserAccessRight	Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)
ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
Subscription	Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
SubscriptionUser	Użytkownik subskrypcji poczty e-mail usługi Power BI

Dataset

Sprzeciwiać się

Zestaw danych usługi Power BI. Interfejs API zwraca podzbiór poniższych właściwości zestawu danych. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.

Nazwa	Typ	Opis
ContentProviderType	string	Przestarzała właściwość, która powinna być ignorowana.
Encryption	Encryption	Informacje o szyfrowaniu zestawu danych. Ma zastosowanie tylko wtedy, gdy określono `$expand`.
IsEffectiveIdentityRequired	boolean	Czy zestaw danych wymaga obowiązującej tożsamości, którą należy wysłać w wywołaniu interfejsu API GenerateToken.
IsEffectiveIdentityRolesRequired	boolean	Określa, czy zabezpieczenia na poziomie wiersza są zdefiniowane wewnątrz pliku pbix usługi Power BI. Jeśli tak, musisz określić rolę.
IsInPlaceSharingEnabled	boolean	Czy zestaw danych może być udostępniany użytkownikom zewnętrznym do użycia we własnej dzierżawie
IsOnPremGatewayRequired	boolean	Czy zestaw danych wymaga lokalnej bramy danych
IsRefreshable	boolean	To pole zwraca `true`, gdy zestaw danych jest ostatnio odświeżony lub jest skonfigurowany do automatycznego odświeżania, a tryb połączenia został specjalnie ustawiony na "Importuj". Wartość zwróci `false` dla innych trybów połączenia, takich jak "DirectQuery" i "LiveConnection", niezależnie od tego, czy zestaw danych jest ręcznie odświeżany, czy skonfigurowany do automatycznego odświeżania.
addRowsAPIEnabled	boolean	Czy zestaw danych umożliwia dodawanie nowych wierszy
configuredBy	string	Właściciel zestawu danych
createReportEmbedURL	string	Adres URL osadzania zestawu danych tworzenia raportu
createdDate	string (date-time)	Data i godzina utworzenia zestawu danych
description	string	Opis zestawu danych
id	string	Identyfikator zestawu danych
name	string	Nazwa zestawu danych
qnaEmbedURL	string	Zestaw danych Q&adres URL osadzania
queryScaleOutSettings	DatasetQueryScaleOutSettings	Ustawienia skalowania zapytań w poziomie zestawu danych
targetStorageMode	string	Tryb przechowywania zestawu danych
upstreamDataflows	DependentDataflow[]	Lista wszystkich przepływów danych, od których zależy ten element
users	DatasetUser[]	(Pusta wartość) Szczegóły dostępu użytkownika zestawu danych. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w elemencie usługi Power BI (takim jak raport lub pulpit nawigacyjny) można pobrać przy użyciu Pobierz użytkowników zestawu danych jako interfejsu API administratora lub interfejsu API PostWorkspaceInfo za pomocą parametru `getArtifactUsers`.
webUrl	string	Internetowy adres URL zestawu danych

DatasetQueryScaleOutSettings

Sprzeciwiać się

Ustawienia skalowania zapytań w poziomie zestawu danych

Nazwa	Typ	Opis
autoSyncReadOnlyReplicas	boolean	Czy zestaw danych automatycznie synchronizuje repliki tylko do odczytu
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	Maksymalna liczba replik tylko do odczytu dla zestawu danych (0–64, -1 dla automatycznej liczby replik)

DatasetUser

Sprzeciwiać się

Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych

Nazwa	Typ	Opis
datasetUserAccessRight	DatasetUserAccessRight	Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień)
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń
emailAddress	string	Adres e-mail użytkownika
graphId	string	Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
userType	string	Typ użytkownika.

DatasetUserAccessRight

Wyliczenie

Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień)

Wartość	Opis
None	Usuwa uprawnienia do zawartości w zestawie danych
Read	Przyznaje dostęp do odczytu zawartości w zestawie danych
ReadWrite	Przyznaje dostęp do odczytu i zapisu do zawartości w zestawie danych
ReadReshare	Przyznaje dostęp do odczytu i udostępniania dalej do zawartości w zestawie danych
ReadWriteReshare	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w zestawie danych
ReadExplore	Przyznaje dostęp do odczytu i eksplorowania zawartości w zestawie danych
ReadReshareExplore	Udziela uprawnień do odczytu, udostępniania dalej i eksplorowania dostępu do zawartości w zestawie danych
ReadWriteExplore	Udziela dostępu do odczytu, zapisu i eksplorowania zawartości w zestawie danych
ReadWriteReshareExplore	Przyznaje dostęp do zawartości w zestawie danych: odczyt, zapis, udostępnianie dalej i eksplorowanie

DependentDataflow

Sprzeciwiać się

Zależny przepływ danych usługi Power BI

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy docelowej
targetDataflowId	string	Identyfikator docelowego przepływu danych

Encryption

Sprzeciwiać się

Informacje o szyfrowaniu zestawu danych

Nazwa	Typ	Opis
EncryptionStatus	EncryptionStatus	Stan szyfrowania zestawu danych

EncryptionStatus

Wyliczenie

Stan szyfrowania zestawu danych

Wartość	Opis
Unknown	Stan szyfrowania jest nieznany z powodu uszkodzenia zestawu danych
NotSupported	Szyfrowanie nie jest obsługiwane dla tego zestawu danych
InSyncWithWorkspace	Szyfrowanie jest obsługiwane i jest synchronizowane z ustawieniami szyfrowania
NotInSyncWithWorkspace	Szyfrowanie jest obsługiwane, ale nie jest zsynchronizowane z ustawieniami szyfrowania

Import

Sprzeciwiać się

Obiekt importu

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Importowanie daty i godziny utworzenia
datasets	Dataset[]	Zestawy danych skojarzone z tym importem
id	string (uuid)	Identyfikator importu
importState	enum: Failed Publishing Succeeded	Stan przekazywania importu
name	string	Nazwa importu
reports	Report[]	Raporty skojarzone z tym importem
updatedDateTime	string (date-time)	Importowanie daty i godziny ostatniej aktualizacji

PrincipalType

Wyliczenie

Typ podmiotu zabezpieczeń

Wartość	Opis
None	Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User	Typ podmiotu zabezpieczeń użytkownika
Group	Typ podmiotu zabezpieczeń grupy
App	Typ jednostki usługi

Report

Sprzeciwiać się

Raport usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości raportu. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.

Nazwa	Typ	Opis
appId	string	Identyfikator aplikacji zwrócony tylko wtedy, gdy raport należy do aplikacji
datasetId	string	Identyfikator zestawu danych raportu
description	string	Opis raportu
embedUrl	string	Adres URL osadzania raportu
format	string	Typ formatu definicji raportu. W przypadku usługi PowerBIReport: PbIR PBIR —starsza wersja W przypadku raportu podzielonego na strony: `RDL`
id	string (uuid)	Identyfikator raportu
isOwnedByMe	boolean	Wskazuje, czy bieżący użytkownik ma możliwość modyfikowania lub tworzenia kopii raportu.
name	string	Nazwa raportu. Raporty aplikacji zaczynają się od prefiksu [App].
originalReportId	string (uuid)	Rzeczywisty identyfikator raportu po opublikowaniu obszaru roboczego jako aplikacja.
reportType	enum: PaginatedReport PowerBIReport	Typ raportu
subscriptions	Subscription[]	(Pusta wartość) Szczegóły subskrypcji elementu usługi Power BI (takie jak raport lub pulpit nawigacyjny). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji raportu usługi Power BI można pobrać przy użyciu Pobierz subskrypcje raportów jako wywołanie interfejsu API administratora.
users	ReportUser[]	(Pusta wartość) Szczegóły dostępu użytkownika dla raportu usługi Power BI. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w raporcie usługi Power BI można pobrać przy użyciu wywołania interfejsu API administratora Pobierz użytkowników raportów lub wywołania interfejsu API PostWorkspaceInfo z parametrem `getArtifactUsers`.
webUrl	string	Internetowy adres URL raportu

ReportUser

Sprzeciwiać się

Wpis prawa dostępu użytkownika usługi Power BI dla raportu

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń
emailAddress	string	Adres e-mail użytkownika
graphId	string	Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)
userType	string	Typ użytkownika.

ReportUserAccessRight

Wyliczenie

Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)

Wartość	Opis
None	Brak uprawnień do zawartości w raporcie
Read	Przyznaje dostęp do odczytu zawartości w raporcie
ReadWrite	Udziela dostępu do odczytu i zapisu do zawartości w raporcie
ReadReshare	Udziela dostępu do odczytu i udostępniania dalej zawartości w raporcie
ReadCopy	Przyznaje dostęp do odczytu i kopiowania zawartości w raporcie
Owner	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie

ServicePrincipalProfile

Sprzeciwiać się

Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.

Nazwa	Typ	Opis
displayName	string	Nazwa profilu jednostki usługi
id	string (uuid)	Identyfikator profilu jednostki usługi

Subscription

Sprzeciwiać się

Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)

Nazwa	Typ	Opis
artifactDisplayName	string	Nazwa subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
artifactId	string (uuid)	Identyfikator subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
artifactType	string	Typ elementu usługi Power BI (na przykład `Report`, `Dashboard`lub `Dataset`)
attachmentFormat	string	Format raportu dołączonego do subskrypcji poczty e-mail
endDate	string (date-time)	Data i godzina zakończenia subskrypcji poczty e-mail
frequency	string	Częstotliwość subskrypcji poczty e-mail
id	string (uuid)	Identyfikator subskrypcji
isEnabled	boolean	Czy subskrypcja poczty e-mail jest włączona
linkToContent	boolean	Czy link subskrypcji istnieje w subskrypcji poczty e-mail
previewImage	boolean	Czy zrzut ekranu raportu istnieje w subskrypcji poczty e-mail
startDate	string (date-time)	Data i godzina rozpoczęcia subskrypcji poczty e-mail
subArtifactDisplayName	string	Nazwa strony subskrybowanego elementu usługi Power BI, jeśli jest to raport.
title	string	Nazwa aplikacji
users	SubscriptionUser[]	Szczegóły poszczególnych subskrybentów poczty e-mail. W przypadku używania wywołania interfejsu API Pobierz subskrypcje użytkowników jako administrator zwracana wartość jest pustą tablicą (null). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji w raporcie lub pulpicie nawigacyjnym usługi Power BI można pobrać przy użyciu Pobierz subskrypcje raportów jako administrator lub Pobierz subskrypcje pulpitu nawigacyjnego jako wywołania interfejsu API administratora.

SubscriptionUser

Sprzeciwiać się

Użytkownik subskrypcji poczty e-mail usługi Power BI

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń
emailAddress	string	Adres e-mail użytkownika
graphId	string	Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
userType	string	Typ użytkownika.

Udostępnij przez

Imports - Get Import

Wymagany zakres

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Completed import example

Przykładowe zapytanie

Przykładowa odpowiedź

In-progress import example

Przykładowe zapytanie

Przykładowa odpowiedź

Definicje

Dataset

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

Import

PrincipalType

Report

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser