Imports - Post Import In Group

  • Odwołanie
Service:
Power BI REST APIs
API Version:
v1.0

Tworzy nową zawartość w określonym obszarze roboczym.

Uwaga

Obsługiwana zawartość:

  • Pliki pbix usługi Power BI
  • Pliki JSON (.json)
  • Pliki programu Excel (.xlsx)
  • pliki języka definicji raportów SQL Server (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 rdl, dołącz rozszerzenie pliku w nazwie określonej przez datasetDisplayName, zgodnie z opisem w parametrach identyfikatora URI.
  • Aby zaimportować plik .xlsx z OneDrive dla Firm, dołącz kod application/json typu zawartości w nagłówkach żądania. Dołącz element ImportInfo z ustawioną filePath ś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 Twórca Tymczasowa lokalizacja przekazywania w grupie i skrypt importu dużych plików programu PowerShell. Jest to obsługiwane tylko w przypadku obszarów roboczych pojemności Premium.
  • Aby utworzyć przepływ danych na podstawie pliku model.json, ustaw wartość datasetDisplayNamemodel.json zgodnie z opisem w parametrach identyfikatora URI.

Uprawnienia

To wywołanie interfejsu API może być wywoływane przez profil jednostki usługi. Aby uzyskać więcej informacji, zobacz: Profile jednostki usługi w Power BI Embedded.

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/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
groupId
 path True

string

uuid

Identyfikator obszaru roboczego
datasetDisplayName
 query True

string

Nazwa wyświetlana zestawu danych powinna zawierać rozszerzenie pliku. Nieobsługiwane podczas importowania z OneDrive dla Firm. W przypadku importowania lub tworzenia przepływów danych ten parametr powinien być zakodowany na stałe w celu model.json.
nameConflict
 query

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. W przypadku plików Abort model.json przepływu danych i GenerateUniqueName są jedynymi obsługiwanymi opcjami.
overrideModelLabel
 query

boolean

Określa, czy zastąpić istniejącą etykietę modelu podczas ponownego publikowania pliku pbix usługi Power BI. Wartość domyślna usługi to true.
overrideReportLabel
 query

boolean

Czy zastąpić istniejącą etykietę raportu podczas ponownego publikowania pliku pbix usługi Power BI. Wartość domyślna usługi to true.
skipReport
 query

boolean

Czy pominąć importowanie raportu. Jeśli zostanie określony, wartość musi mieć wartość true. Obsługiwane tylko w przypadku plików pbix usługi Power BI.
subfolderObjectId
 query

string

uuid

Identyfikator podfolderu do zaimportowania pliku do podfolderu.

Treść żądania

Media Types: "application/json", "multipart/form-data"

Nazwa Typ Opis
connectionType

connectionType

Typ połączenia importu dla pliku OneDrive dla Firm
filePath

string

Ścieżka pliku OneDrive dla Firm Excel (.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 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

Import

OK
202 Accepted

Import

Zaakceptowano

Przykłady

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Request Body
{
  "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--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Definicje

Nazwa Opis
connectionType

Typ połączenia importu dla pliku OneDrive dla Firm
Dataset

Zestaw danych usługi Power BI. Interfejs API zwraca podzestaw następujących 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

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
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 są Overwrite jedynymi obsługiwanymi opcjami. W przypadku plików Abort model.json przepływu danych i GenerateUniqueName są jedynymi obsługiwanymi opcjami.
ImportInfo

Informacje o importowaniu
PrincipalType

Typ podmiotu zabezpieczeń
Report

Raport usługi Power BI. Interfejs API zwraca podzbiór następujących właściwości raportu. Podzbiór 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 główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
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

connectionType

Typ połączenia importu dla pliku OneDrive dla Firm

Nazwa Typ Opis
connect

string

import

string

Dataset

Zestaw danych usługi Power BI. Interfejs API zwraca podzestaw następujących 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

Typ dostawcy zawartości dla zestawu danych
CreateReportEmbedURL

string

Adres URL osadzania raportu tworzenia zestawu danych
CreatedDate

string

Data i godzina utworzenia zestawu danych
Encryption

Encryption

Informacje o szyfrowaniu zestawu danych. Ma zastosowanie tylko wtedy, gdy $expand jest określony.
IsEffectiveIdentityRequired

boolean

Określa, 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

Określa, 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

Niezależnie od tego, czy zestaw danych jest odświeżalny, czy nie. Zestaw danych z możliwością odświeżania usługi Power BI to zestaw danych, który został odświeżony co najmniej raz lub dla którego istnieje prawidłowy harmonogram odświeżania.
QnaEmbedURL

string

Zestaw danych Q&adres URL osadzania
addRowsAPIEnabled

boolean

Czy zestaw danych umożliwia dodawanie nowych wierszy
configuredBy

string

Właściciel zestawu danych
description

string

Opis zestawu danych
id

string

Identyfikator zestawu danych
name

string

Nazwa zestawu danych
queryScaleOutSettings

DatasetQueryScaleOutSettings

Wykonywanie zapytań dotyczących ustawień skalowania 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 interfejsu API pobierz zestaw danych jako interfejsu API Administracja lub interfejsu API PostWorkspaceInfo z parametrem getArtifactUsers .
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

Maksymalna liczba replik tylko do odczytu dla zestawu danych (0-64, -1 dla automatycznej liczby replik)

DatasetUser

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 administratora.
identifier

string

Identyfikator podmiotu zabezpieczeń
principalType

PrincipalType

Typ podmiotu zabezpieczeń
profile

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
userType

string

Typ użytkownika.

DatasetUserAccessRight

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

Nazwa Typ Opis
None

string

Usuwa uprawnienia do zawartości w zestawie danych
Read

string

Udziela dostępu do odczytu zawartości w zestawie danych
ReadExplore

string

Udziela dostępu do odczytu i eksplorowania zawartości w zestawie danych
ReadReshare

string

Udziela dostępu do odczytu i udostępniania dalej do zawartości w zestawie danych
ReadReshareExplore

string

Udziela uprawnień do odczytu, udostępniania dalej i eksplorowania dostępu do zawartości w zestawie danych
ReadWrite

string

Udziela dostępu do odczytu i zapisu zawartości w zestawie danych
ReadWriteExplore

string

Udziela dostępu do odczytu, zapisu i eksplorowania zawartości w zestawie danych
ReadWriteReshare

string

Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w zestawie danych
ReadWriteReshareExplore

string

Udziela dostępu do zawartości w zestawie danych: odczyt, zapis, udostępnianie 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

EncryptionStatus

Stan szyfrowania zestawu danych

EncryptionStatus

Stan szyfrowania zestawu danych

Nazwa Typ Opis
InSyncWithWorkspace

string

Szyfrowanie jest obsługiwane i jest synchronizowane z ustawieniami szyfrowania
NotInSyncWithWorkspace

string

Szyfrowanie jest obsługiwane, ale nie jest zsynchronizowane z ustawieniami szyfrowania
NotSupported

string

Szyfrowanie nie jest obsługiwane dla tego zestawu danych
Unknown

string

Stan szyfrowania jest nieznany z powodu uszkodzenia zestawu danych

Import

Obiekt importu

Nazwa Typ Opis
createdDateTime

string

Data i godzina utworzenia importu
datasets

Dataset[]

Zestawy danych skojarzone z tym importem
id

string

Identyfikator importu
importState enum:
  • Failed
  • Publishing
  • Succeeded

Stan przekazywania importu
name

string

Nazwa importu
reports

Report[]

Raporty skojarzone z tym importem
updatedDateTime

string

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 są Overwrite jedynymi obsługiwanymi opcjami. W przypadku plików Abort model.json przepływu danych i GenerateUniqueName są jedynymi obsługiwanymi opcjami.

Nazwa Typ Opis
Abort

string

Jeśli zestaw danych lub przepływ danych o tej samej nazwie już istnieje, operacja importowania zostanie anulowana.
CreateOrOverwrite

string

Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania zastąpi istniejący zestaw danych nowym. Operacja importowania zakończy się niepowodzeniem, jeśli istnieje więcej niż jeden istniejący zestaw danych o tej samej nazwie.
GenerateUniqueName

string

Jeśli przepływ danych o tej samej nazwie już istnieje, operacja importowania wygeneruje nową unikatową nazwę nowego przepływu danych.
Ignore

string

Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania utworzy nowy zestaw danych o tej samej nazwie.
Overwrite

string

Jeśli zestaw danych o tej samej nazwie już istnieje, operacja importowania zastąpi istniejący zestaw danych nowym. Operacja importowania zakończy się niepowodzeniem, jeśli nie wystąpi konflikt lub istnieje więcej niż jeden istniejący zestaw danych o tej samej nazwie.

ImportInfo

Informacje o importowaniu

Nazwa Typ Opis
connectionType

connectionType

Typ połączenia importu dla pliku OneDrive dla Firm
filePath

string

Ścieżka pliku OneDrive dla Firm Excel (.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 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ń

Nazwa Typ Opis
App

string

Typ jednostki usługi
Group

string

Typ podmiotu zabezpieczeń grupy
None

string

Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User

string

Typ podmiotu zabezpieczeń użytkownika

Report

Raport usługi Power BI. Interfejs API zwraca podzbiór następujących właściwości raportu. Podzbiór 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
id

string

Identyfikator raportu
isOwnedByMe

boolean

Ustal, czy raport jest tworzony przez bieżącego użytkownika.
name

string

Nazwa raportu
originalReportId

string

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 dla raportu usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierania raportów jako Administracja.
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 pobierania raportów jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem getArtifactUsers .
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 administratora.
identifier

string

Identyfikator podmiotu zabezpieczeń
principalType

PrincipalType

Typ podmiotu zabezpieczeń
profile

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
reportUserAccessRight

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ń)

Nazwa Typ Opis
None

string

Brak uprawnień do zawartości w raporcie
Owner

string

Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie
Read

string

Udziela dostępu do odczytu zawartości w raporcie
ReadCopy

string

Udziela dostępu do odczytu i kopiowania zawartości w raporcie
ReadReshare

string

Udziela dostępu do odczytu i udostępniania dalej do zawartości w raporcie
ReadWrite

string

Udziela dostępu do odczytu i zapisu zawartości w raporcie

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.

Nazwa Typ Opis
displayName

string

Nazwa profilu jednostki usługi
id

string

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

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, Dashboardlub Dataset)
attachmentFormat

string

Format raportu dołączonego do subskrypcji poczty e-mail
endDate

string

Data i godzina zakończenia subskrypcji e-mail
frequency

string

Częstotliwość subskrypcji poczty e-mail
id

string

Identyfikator subskrypcji
isEnabled

boolean

Czy subskrypcja poczty e-mail jest włączona
linkToContent

boolean

Czy link subskrypcji istnieje w subskrypcji e-mail
previewImage

boolean

Czy na zrzucie ekranu raportu istnieje subskrypcja poczty e-mail
startDate

string

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 każdego subskrybenta poczty e-mail. W przypadku korzystania z wywołania interfejsu API Get User Subscriptions As Administracja 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ć za pomocą polecenia Pobierz subskrypcje raportów jako Administracja lub Pobierz subskrypcje pulpitu nawigacyjnego Jako wywołania interfejsu API Administracja.

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 administratora.
identifier

string

Identyfikator podmiotu zabezpieczeń
principalType

PrincipalType

Typ podmiotu zabezpieczeń
profile

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
userType

string

Typ użytkownika.