Imports - Post Import
Tworzy nową zawartość w Mój obszar roboczy.
Zobacz Importowanie dużych plików skryptu programu PowerShell, aby zapoznać się z przykładem użycia tego interfejsu API.
Uwaga
Obsługiwana zawartość:
- Pliki pbix usługi Power BI
- Pliki JSON (.json)
- Pliki programu Excel (.xlsx)
- Pliki języka definicji raportu (rdl)
- Aby zaimportować plik, określ typ zawartości multipart/form-data w nagłówkach żądania i zakoduj plik jako dane formularza w treści żądania.
- Aby zaimportować plik Raporty podzielone na strony (rdl), dołącz rozszerzenie pliku rdl w nazwie określonej przez
datasetDisplayNamepaginatedReport.rdl, zgodnie z opisem w parametrach identyfikatora URI. Rozszerzenie pliku w programie ułatwi odróżnienie przekazywania raportu podzielonegodatasetDisplayNamena strony (pliku rdl) z innych przekazywania.- Zaleca się również używanie zestawu SDK języka C# (Galeria NuGet | Microsoft.PowerBI.Api) dla przekazywania raportów podzielonych na strony (rdl).
- Aby zaimportować plik .xlsx z usługi OneDrive dla Firm, dołącz typ zawartości application/json w nagłówkach żądania. Dołącz ImportInfo z
filePathustawioną na ścieżkę pliku .xlsx w treści żądania. - Aby zaimportować duże pliki pbix usługi Power BI o rozmiarze od 1 GB do 10 GB, zobacz Create Temporary Upload Location (Tworzenie lokalizacji tymczasowego przekazywania). Jest to obsługiwane tylko w przypadku obszarów roboczych pojemności Premium.
- Aby utworzyć przepływ danych na podstawie pliku model.json, ustaw
datasetDisplayNamena model.json, zgodnie z opisem w parametrów identyfikatora URI.
Wymagany zakres
Dataset.ReadWrite.All
Ograniczenia
- Przepływy danych z jednostką usługi nie są obsługiwane.
- Importowanie pliku pbix usługi Power BI z usługi OneDrive nie jest obsługiwane.
- Importowanie pliku z chronioną etykietą poufności nie jest obsługiwane w przypadku jednostek usługi.
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
dataset
|
query | True |
string |
Nazwa wyświetlana zestawu danych powinna zawierać rozszerzenie pliku. Nieobsługiwane podczas importowania z usługi OneDrive dla Firm. |
|
name
|
query |
Określa, co zrobić, jeśli zestaw danych o tej samej nazwie już istnieje. Wartość domyślna to |
||
|
override
|
query |
boolean |
Czy zastąpić istniejącą etykietę modelu podczas ponownego publikowania pliku pbix usługi Power BI. Wartość domyślna usługi to |
|
|
override
|
query |
boolean |
Czy zastąpić istniejącą etykietę raportu podczas ponownego publikowania pliku pbix usługi Power BI. Wartość domyślna usługi to |
|
|
skip
|
query |
boolean |
Czy pominąć importowanie raportu. Jeśli zostanie określona, wartość musi być |
|
|
subfolder
|
query |
string (uuid) |
Identyfikator podfolderu do zaimportowania pliku do podfolderu. |
Treść żądania
| Nazwa | Typ | Opis |
|---|---|---|
| connectionType |
Typ połączenia importu dla pliku usługi OneDrive dla Firm |
|
| filePath |
string |
Ścieżka pliku programu Excel w usłudze OneDrive dla Firm (.xlsx) do zaimportowania, który może być bezwzględny lub względny. Pliki pbix usługi Power BI nie są obsługiwane. |
| fileUrl |
string |
Adres URL sygnatury dostępu współdzielonego tymczasowego magazynu obiektów blob używany do importowania dużych plików pbix usługi Power BI o rozmiarze od 1 GB do 10 GB. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK |
|
| 202 Accepted |
Zaakceptowano |
Przykłady
| Import dataflow example |
| Post import example |
|
Post import with 'skip |
Import dataflow example
Przykładowe zapytanie
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=model.json&nameConflict=Abort
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data name=model.json; filename=model.json Content-Type: application/json [Contents of Model JSON Encoded] --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Przykładowa odpowiedź
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Post import example
Przykładowe zapytanie
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Przykładowa odpowiedź
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Post import with 'skipReport' example
Przykładowe zapytanie
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Przykładowa odpowiedź
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Definicje
| Nazwa | Opis |
|---|---|
|
connection |
Typ połączenia importu dla pliku usługi OneDrive dla Firm |
| 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. |
|
Dataset |
Ustawienia skalowania zapytań w poziomie zestawu danych |
|
Dataset |
Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych |
|
Dataset |
Prawo dostępu, które użytkownik ma dla zestawu danych (poziom uprawnień) |
|
Dependent |
Zależny przepływ danych usługi Power BI |
| Encryption |
Informacje o szyfrowaniu zestawu danych |
|
Encryption |
Stan szyfrowania zestawu danych |
| Import |
Obiekt importu |
|
Import |
Określa, co zrobić, jeśli zestaw danych o tej samej nazwie już istnieje. Wartość domyślna to |
|
Import |
Informacje o importowaniu |
|
Principal |
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. |
|
Report |
Wpis prawa dostępu użytkownika usługi Power BI dla raportu |
|
Report |
Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień) |
|
Service |
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) |
|
Subscription |
Użytkownik subskrypcji poczty e-mail usługi Power BI |
connectionType
Typ połączenia importu dla pliku usługi OneDrive dla Firm
| Wartość | Opis |
|---|---|
| import | |
| connect |
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.
| Nazwa | Typ | Opis |
|---|---|---|
| ContentProviderType |
string |
Przestarzała właściwość, która powinna być ignorowana. |
| Encryption |
Informacje o szyfrowaniu zestawu danych. Ma zastosowanie tylko wtedy, gdy określono |
|
| 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 |
| 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 |
Ustawienia skalowania zapytań w poziomie zestawu danych |
|
| targetStorageMode |
string |
Tryb przechowywania zestawu danych |
| upstreamDataflows |
Lista wszystkich przepływów danych, od których zależy ten element |
|
| users |
(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 |
|
| webUrl |
string |
Internetowy adres URL zestawu danych |
DatasetQueryScaleOutSettings
Ustawienia skalowania zapytań w poziomie zestawu danych
| Nazwa | Typ | Opis |
|---|---|---|
| autoSyncReadOnlyReplicas |
boolean |
Czy zestaw danych automatycznie synchronizuje repliki tylko do odczytu |
| maxReadOnlyReplicas |
integer minimum: -1maximum: 64 |
Maksymalna liczba replik tylko do odczytu dla zestawu danych (0–64, -1 dla automatycznej liczby replik) |
DatasetUser
Wpis prawa dostępu użytkownika usługi Power BI dla zestawu danych
| Nazwa | Typ | Opis |
|---|---|---|
| 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 |
Typ podmiotu zabezpieczeń |
|
| profile |
Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded. |
|
| userType |
string |
Typ użytkownika. |
DatasetUserAccessRight
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
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
Informacje o szyfrowaniu zestawu danych
| Nazwa | Typ | Opis |
|---|---|---|
| EncryptionStatus |
Stan szyfrowania zestawu danych |
EncryptionStatus
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
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:
|
Stan przekazywania importu |
| name |
string |
Nazwa importu |
| reports |
Report[] |
Raporty skojarzone z tym importem |
| updatedDateTime |
string (date-time) |
Importowanie daty i godziny ostatniej aktualizacji |
ImportConflictHandlerMode
Określa, co zrobić, jeśli zestaw danych o tej samej nazwie już istnieje. Wartość domyślna to Ignore. W przypadku plików Abort RDL i Overwrite są jedynymi obsługiwanymi opcjami, a nie innymi.
| Wartość | Opis |
|---|---|
| Ignore |
Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania utworzy nowy zestaw danych o tej samej nazwie. |
| Abort |
Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania zostanie anulowana. |
| Overwrite |
Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania zastąpi istniejący zestaw danych nowym zestawem danych. Operacja importowania zakończy się niepowodzeniem, jeśli nie występuje konflikt lub istnieje więcej niż jeden istniejący zestaw danych o tej samej nazwie. |
| CreateOrOverwrite |
Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania zastąpi istniejący zestaw danych nowym zestawem danych. Operacja importowania zakończy się niepowodzeniem, jeśli istnieje więcej niż jeden istniejący zestaw danych o tej samej nazwie. |
| GenerateUniqueName |
Jeśli przepływ danych o tej samej nazwie już istnieje, operacja importowania wygeneruje nową unikatową nazwę nowego przepływu danych. |
ImportInfo
Informacje o importowaniu
| Nazwa | Typ | Opis |
|---|---|---|
| connectionType |
Typ połączenia importu dla pliku usługi OneDrive dla Firm |
|
| filePath |
string |
Ścieżka pliku programu Excel w usłudze OneDrive dla Firm (.xlsx) do zaimportowania, który może być bezwzględny lub względny. Pliki pbix usługi Power BI nie są obsługiwane. |
| fileUrl |
string |
Adres URL sygnatury dostępu współdzielonego tymczasowego magazynu obiektów blob używany do importowania dużych plików pbix usługi Power BI o rozmiarze od 1 GB do 10 GB. |
PrincipalType
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
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: W przypadku raportu podzielonego na strony: |
| 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:
|
Typ raportu |
| subscriptions |
(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 |
(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 |
|
| webUrl |
string |
Internetowy adres URL raportu |
ReportUser
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 |
Typ podmiotu zabezpieczeń |
|
| profile |
Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded. |
|
| reportUserAccessRight |
Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień) |
|
| userType |
string |
Typ użytkownika. |
ReportUserAccessRight
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
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
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 |
| 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 |
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
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 |
Typ podmiotu zabezpieczeń |
|
| profile |
Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded. |
|
| userType |
string |
Typ użytkownika. |