Imports - Post Import
Vytvoří nový obsah v pracovním prostoru.
Příklad použití tohoto rozhraní API najdete ve skriptu PowerShellu pro import velkých souborů .
Poznámka
Podporovaný obsah:
- Soubory .pbix v Power BI
- Soubory JSON (.json)
- Excelové soubory (.xlsx)
- Soubory RDL (.rdl)
- Pokud chcete importovat soubor, zadejte v hlavičce požadavku typ obsahu multipart/form-data a zakódujte soubor jako data formuláře v textu požadavku.
- Pokud chcete importovat soubor .rdl, zahrňte příponu souboru do názvu určeného parametrem
datasetDisplayName
, jak je popsáno v parametrech identifikátoru URI. - Pokud chcete importovat soubor .xlsx z OneDrive pro firmy, zahrňte do hlaviček požadavku typ obsahu application/json. Zahrnout ImportInfo s
filePath
nastavenou na .xlsx cestu k souboru v textu požadavku. - Pokud chcete importovat velké soubory Power BI .pbix o velikosti od 1 GB do 10 GB, přečtěte si téma Create umístění dočasného odeslání. To se podporuje pouze u pracovních prostorů kapacity Premium.
- Pokud chcete vytvořit tok dat ze souboru model.json, nastavte
datasetDisplayName
na model.json, jak je popsáno v části Parametry identifikátoru URI.
Požadovaný obor
Dataset.ReadWrite.All
Omezení
- Toky dat s instančním objektem se nepodporují.
- Import souboru .pbix Power BI z OneDrivu není podporovaný.
- Instanční objekty nepodporují import souboru s chráněným popiskem citlivosti.
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 identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
dataset
|
query | True |
string |
Zobrazovaný název datové sady by měl obsahovat příponu souboru. Nepodporuje se při importu z OneDrive pro firmy. |
name
|
query |
Určuje, co se má dělat, pokud už datová sada se stejným názvem existuje. Výchozí hodnota je |
||
override
|
query |
boolean |
Určuje, jestli se má při opětovném publikování souboru .pbix Power BI přepsat existující popisek modelu. Výchozí hodnota služby je |
|
override
|
query |
boolean |
Jestli se má při opětovném publikování souboru .pbix Power BI přepsat existující popisek sestavy. Výchozí hodnota služby je |
|
skip
|
query |
boolean |
Jestli se má přeskočit import sestav. Pokud je zadaný, musí být |
|
subfolder
|
query |
string uuid |
ID podsložky pro import souboru do podsložky. |
Text požadavku
Media Types: "application/json", "multipart/form-data"
Name | Typ | Description |
---|---|---|
connectionType |
Typ připojení importu souboru OneDrive pro firmy |
|
filePath |
string |
Cesta k souboru OneDrive pro firmy Excelu (.xlsx) k importu, která může být absolutní nebo relativní. Soubory .pbix Power BI se nepodporují. |
fileUrl |
string |
Adresa URL sdíleného přístupového podpisu dočasného úložiště objektů blob, která slouží k importu velkých souborů Power BI .pbix o velikosti 1 GB až 10 GB. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Přijato |
Příklady
Import dataflow example |
Post import example |
Post import with 'skip |
Import dataflow example
Sample Request
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--"
}
Sample Response
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Post import example
Sample Request
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--"
}
Sample Response
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Post import with 'skipReport' example
Sample Request
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--"
}
Sample Response
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Definice
Name | Description |
---|---|
connection |
Typ připojení importu pro soubor OneDrive pro firmy |
Dataset |
Datová sada Power BI. Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností datové sady. Podmnožina závisí na volaným rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI. |
Dataset |
Nastavení škálování dotazu na více instancí datové sady |
Dataset |
Položka přístupových práv uživatele Power BI pro datovou sadu |
Dataset |
Přístupová práva, která má uživatel k datové sadě (úroveň oprávnění) |
Dependent |
Tok dat závislý na Power BI |
Encryption |
Informace o šifrování datové sady |
Encryption |
Stav šifrování datové sady |
Import |
Objekt importu |
Import |
Určuje, co dělat, pokud už datová sada se stejným názvem existuje. Výchozí hodnota je |
Import |
Informace o importu |
Principal |
Typ objektu zabezpečení |
Report |
Sestava Power BI. Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností sestavy. Podmnožina závisí na volaného rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI. |
Report |
Položka přístupového práva uživatele Power BI pro sestavu |
Report |
Přístupová práva, která má uživatel k sestavě (úroveň oprávnění) |
Service |
Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty. |
Subscription |
Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel) |
Subscription |
Uživatel e-mailového předplatného Power BI |
connectionType
Typ připojení importu pro soubor OneDrive pro firmy
Name | Typ | Description |
---|---|---|
connect |
string |
|
import |
string |
Dataset
Datová sada Power BI. Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností datové sady. Podmnožina závisí na volaným rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.
Name | Typ | Description |
---|---|---|
ContentProviderType |
string |
Typ zprostředkovatele obsahu pro datovou sadu |
CreateReportEmbedURL |
string |
Adresa URL pro vložení sestavy pro vytvoření datové sady |
CreatedDate |
string |
Datum a čas vytvoření datové sady |
Encryption |
Informace o šifrování datové sady. Platí pouze v případě, že |
|
IsEffectiveIdentityRequired |
boolean |
Jestli datová sada vyžaduje efektivní identitu, kterou musíte odeslat ve volání rozhraní API GenerateToken . |
IsEffectiveIdentityRolesRequired |
boolean |
Určuje, jestli je v souboru .pbix Power BI definované zabezpečení na úrovni řádků. Pokud ano, musíte zadat roli. |
IsInPlaceSharingEnabled |
boolean |
Jestli je možné datovou sadu sdílet s externími uživateli, aby ji mohli využívat ve svém vlastním tenantovi. |
IsOnPremGatewayRequired |
boolean |
Jestli datová sada vyžaduje místní bránu dat |
IsRefreshable |
boolean |
Jestli je datová sada aktualizovatelná nebo ne. Aktualizovatelná datová sada Power BI je datová sada, která se alespoň jednou aktualizovala nebo pro kterou existuje platný plán aktualizace. |
QnaEmbedURL |
string |
Adresa URL pro vložení Q&A datové sady |
addRowsAPIEnabled |
boolean |
Jestli datová sada umožňuje přidávat nové řádky |
configuredBy |
string |
Vlastník datové sady |
description |
string |
Popis datové sady |
id |
string |
ID datové sady |
name |
string |
Název datové sady |
queryScaleOutSettings |
Dotaz na nastavení škálování datové sady na více instancí |
|
targetStorageMode |
string |
Režim úložiště datové sady |
upstreamDataflows |
Seznam všech toků dat, na které tato položka závisí |
|
users |
(Prázdná hodnota) Podrobnosti o přístupu uživatele k datové sadě Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživatelích u položky Power BI (například sestavy nebo řídicího panelu) můžete načíst pomocí rozhraní API Get Dataset Users as Správa nebo rozhraní API PostWorkspaceInfo s parametrem |
|
webUrl |
string |
Webová adresa URL datové sady |
DatasetQueryScaleOutSettings
Nastavení škálování dotazu na více instancí datové sady
Name | Typ | Description |
---|---|---|
autoSyncReadOnlyReplicas |
boolean |
Jestli datová sada automaticky synchronizuje repliky jen pro čtení |
maxReadOnlyReplicas |
integer |
Maximální počet replik jen pro čtení pro datovou sadu (0–64, -1 pro automatický počet replik) |
DatasetUser
Položka přístupových práv uživatele Power BI pro datovou sadu
Name | Typ | Description |
---|---|---|
datasetUserAccessRight |
Přístupová práva, která má uživatel k datové sadě (úroveň oprávnění) |
|
displayName |
string |
Zobrazovaný název objektu zabezpečení |
emailAddress |
string |
E-mailová adresa uživatele |
graphId |
string |
Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu. |
identifier |
string |
Identifikátor objektu zabezpečení |
principalType |
Typ objektu zabezpečení |
|
profile |
Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty. |
|
userType |
string |
Typ uživatele. |
DatasetUserAccessRight
Přístupová práva, která má uživatel k datové sadě (úroveň oprávnění)
Name | Typ | Description |
---|---|---|
None |
string |
Odebere oprávnění k obsahu v datové sadě. |
Read |
string |
Udělí oprávnění ke čtení obsahu v datové sadě. |
ReadExplore |
string |
Uděluje přístup ke čtení a prozkoumání obsahu v datové sadě. |
ReadReshare |
string |
Uděluje přístup ke čtení a sdílení obsahu v datové sadě. |
ReadReshareExplore |
string |
Uděluje přístup ke čtení, sdílení a prozkoumání obsahu v datové sadě. |
ReadWrite |
string |
Udělí přístup ke čtení a zápisu k obsahu v datové sadě. |
ReadWriteExplore |
string |
Udělí přístup ke čtení, zápisu a prozkoumání obsahu datové sady. |
ReadWriteReshare |
string |
Uděluje přístup ke čtení, zápisu a sdílení obsahu v datové sadě. |
ReadWriteReshareExplore |
string |
Uděluje přístup ke čtení, zápisu, sdílení a prozkoumání obsahu datové sady. |
DependentDataflow
Tok dat závislý na Power BI
Name | Typ | Description |
---|---|---|
groupId |
string |
ID cílové skupiny |
targetDataflowId |
string |
ID cílového toku dat |
Encryption
Informace o šifrování datové sady
Name | Typ | Description |
---|---|---|
EncryptionStatus |
Stav šifrování datové sady |
EncryptionStatus
Stav šifrování datové sady
Name | Typ | Description |
---|---|---|
InSyncWithWorkspace |
string |
Šifrování se podporuje a je synchronizované s nastavením šifrování. |
NotInSyncWithWorkspace |
string |
Šifrování je podporované, ale není synchronizované s nastavením šifrování. |
NotSupported |
string |
Šifrování se pro tuto datovou sadu nepodporuje. |
Unknown |
string |
Stav šifrování je neznámý kvůli poškození datové sady. |
Import
Objekt importu
Name | Typ | Description |
---|---|---|
createdDateTime |
string |
Datum a čas vytvoření importu |
datasets |
Dataset[] |
Datové sady přidružené k tomuto importu |
id |
string |
ID importu |
importState |
enum:
|
Stav nahrání importu |
name |
string |
Název importu |
reports |
Report[] |
Sestavy přidružené k tomuto importu |
updatedDateTime |
string |
Importovat datum a čas poslední aktualizace |
ImportConflictHandlerMode
Určuje, co dělat, pokud už datová sada se stejným názvem existuje. Výchozí hodnota je Ignore
. Pro soubory Abort
RDL a Overwrite
jsou jedinými podporovanými možnostmi.
Name | Typ | Description |
---|---|---|
Abort |
string |
Pokud už datová sada se stejným názvem existuje, operace importu se zruší. |
CreateOrOverwrite |
string |
Pokud už datová sada se stejným názvem existuje, operace importu nahradí stávající datovou sadu novou. Operace importu selže, pokud existuje více než jedna datová sada se stejným názvem. |
GenerateUniqueName |
string |
Pokud už tok dat se stejným názvem existuje, operace importu vygeneruje nový jedinečný název nového toku dat. |
Ignore |
string |
Pokud už datová sada se stejným názvem existuje, operace importu vytvoří novou datovou sadu se stejným názvem. |
Overwrite |
string |
Pokud už datová sada se stejným názvem existuje, operace importu nahradí stávající datovou sadu novou. Operace importu selže, pokud neexistuje žádný konflikt nebo pokud existuje více než jedna datová sada se stejným názvem. |
ImportInfo
Informace o importu
Name | Typ | Description |
---|---|---|
connectionType |
Typ připojení importu pro soubor OneDrive pro firmy |
|
filePath |
string |
Cesta k souboru OneDrive pro firmy Excelu (.xlsx) k importu, která může být absolutní nebo relativní. Soubory .pbix Power BI se nepodporují. |
fileUrl |
string |
Adresa URL sdíleného přístupového podpisu dočasného úložiště objektů blob použitého k importu velkých souborů Power BI .pbix o velikosti 1 GB až 10 GB |
PrincipalType
Typ objektu zabezpečení
Name | Typ | Description |
---|---|---|
App |
string |
Typ instančního objektu |
Group |
string |
Typ objektu zabezpečení skupiny |
None |
string |
Žádný typ objektu zabezpečení. Použijte pro přístup na úrovni celé organizace. |
User |
string |
Typ objektu zabezpečení uživatele |
Report
Sestava Power BI. Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností sestavy. Podmnožina závisí na volaného rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.
Name | Typ | Description |
---|---|---|
appId |
string |
ID aplikace, které se vrátí jenom v případě, že sestava patří aplikaci |
datasetId |
string |
ID datové sady sestavy |
description |
string |
Popis sestavy |
embedUrl |
string |
Adresa URL pro vložení sestavy |
id |
string |
ID sestavy |
isOwnedByMe |
boolean |
Určete, jestli sestavu vytvořil aktuální uživatel. |
name |
string |
Název sestavy |
originalReportId |
string |
Skutečné ID sestavy při publikování pracovního prostoru jako aplikace |
reportType |
enum:
|
Typ sestavy |
subscriptions |
(Prázdná hodnota) Podrobnosti o předplatném pro položku Power BI (například sestavu nebo řídicí panel). Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném pro sestavu Power BI můžete načíst pomocí volání Získat odběry sestav jako Správa rozhraní API. |
|
users |
(Prázdná hodnota) Podrobnosti o přístupu uživatele k sestavě Power BI Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživatelích v sestavě Power BI můžete načíst pomocí volání Rozhraní API Get Report Users as Správa nebo pomocí volání rozhraní API PostWorkspaceInfo s parametrem |
|
webUrl |
string |
Webová adresa URL sestavy |
ReportUser
Položka přístupového práva uživatele Power BI pro sestavu
Name | Typ | Description |
---|---|---|
displayName |
string |
Zobrazovaný název objektu zabezpečení |
emailAddress |
string |
E-mailová adresa uživatele |
graphId |
string |
Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu. |
identifier |
string |
Identifikátor objektu zabezpečení |
principalType |
Typ objektu zabezpečení |
|
profile |
Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty. |
|
reportUserAccessRight |
Přístupové právo, které má uživatel k sestavě (úroveň oprávnění) |
|
userType |
string |
Typ uživatele. |
ReportUserAccessRight
Přístupová práva, která má uživatel k sestavě (úroveň oprávnění)
Name | Typ | Description |
---|---|---|
None |
string |
Žádná oprávnění k obsahu v sestavě |
Owner |
string |
Uděluje přístup ke čtení, zápisu a sdílení obsahu v sestavě. |
Read |
string |
Uděluje přístup ke čtení obsahu v sestavě. |
ReadCopy |
string |
Uděluje přístup ke čtení a kopírování obsahu v sestavě. |
ReadReshare |
string |
Uděluje přístup ke čtení a sdílení obsahu v sestavě. |
ReadWrite |
string |
Uděluje přístup ke čtení a zápisu k obsahu v sestavě. |
ServicePrincipalProfile
Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
Name | Typ | Description |
---|---|---|
displayName |
string |
Název profilu instančního objektu |
id |
string |
ID profilu instančního objektu |
Subscription
Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)
Name | Typ | Description |
---|---|---|
artifactDisplayName |
string |
Název odebírané položky Power BI (například sestavy nebo řídicího panelu) |
artifactId |
string |
ID odebírané položky Power BI (například sestavy nebo řídicího panelu) |
artifactType |
string |
Typ položky Power BI (například |
attachmentFormat |
string |
Formát sestavy připojené k odběru e-mailu |
endDate |
string |
Koncové datum a čas odběru e-mailu |
frequency |
string |
Frekvence odběru e-mailu |
id |
string |
ID předplatného |
isEnabled |
boolean |
Jestli je povolené předplatné e-mailu |
linkToContent |
boolean |
Jestli v e-mailovém předplatném existuje odkaz na předplatné |
previewImage |
boolean |
Jestli v odběru e-mailu existuje snímek obrazovky se sestavou |
startDate |
string |
Počáteční datum a čas odběru e-mailu |
subArtifactDisplayName |
string |
Název stránky odebírané položky Power BI, pokud se jedná o sestavu. |
title |
string |
Název aplikace |
users |
Podrobnosti o každém odběrateli e-mailu. Při použití volání rozhraní API Get User Subscriptions As Správa je vrácená hodnota prázdné pole (null). Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o předplatném sestavy nebo řídicího panelu Power BI můžete načíst pomocí volání rozhraní API Získat odběry sestav jako Správa nebo Získat odběry řídicího panelu jako Správa. |
SubscriptionUser
Uživatel e-mailového předplatného Power BI
Name | Typ | Description |
---|---|---|
displayName |
string |
Zobrazovaný název objektu zabezpečení |
emailAddress |
string |
E-mailová adresa uživatele |
graphId |
string |
Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu. |
identifier |
string |
Identifikátor objektu zabezpečení |
principalType |
Typ objektu zabezpečení |
|
profile |
Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty. |
|
userType |
string |
Typ uživatele. |