Imports - Post Import In Group

Referensi

Layanan:: Power BI REST APIs

Versi API:: v1.0

Membuat konten baru di ruang kerja yang ditentukan.

Catatan

Konten yang didukung:

File .pbix Power BI
File JSON (.json)
File Excel (.xlsx)
SQL Server File Bahasa Definisi Laporan (.rdl)

Untuk mengimpor file, tentukan tipe konten multipart/form-data di header permintaan dan kodekan file sebagai data formulir dalam isi permintaan.
Untuk mengimpor file .rdl, sertakan ekstensi file dalam nama yang ditentukan oleh datasetDisplayName, seperti yang dijelaskan dalam parameter URI.
Untuk mengimpor file .xlsx dari OneDrive for Business, sertakan aplikasi/json jenis konten di header permintaan. Sertakan ImportInfo dengan filePath diatur ke jalur file .xlsx dalam isi permintaan.
Untuk mengimpor file .pbix Power BI besar yang berukuran antara 1 GB dan 10 GB, lihat Create Lokasi Unggahan Sementara Dalam Grup dan skrip PowerShell Impor File Besar. Ini hanya didukung untuk ruang kerja kapasitas Premium.
Untuk membuat aliran data dari file model.json, atur datasetDisplayName ke model.json, seperti yang dijelaskan dalam parameter URI.

Izin

Panggilan API ini dapat dipanggil oleh profil perwakilan layanan. Untuk informasi selengkapnya lihat: Profil perwakilan layanan di Power BI Embedded.

Cakupan yang Diperlukan

Dataset.ReadWrite.All

Batasan

Aliran data dengan perwakilan layanan tidak didukung.
Mengimpor file .pbix Power BI dari OneDrive tidak didukung.
Mengimpor file yang memiliki label sensitivitas yang dilindungi tidak didukung untuk perwakilan layanan.

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}

Dengan parameter opsional:

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
groupId	path	True	string uuid	ID ruang kerja
datasetDisplayName	query	True	string	Nama tampilan himpunan data harus menyertakan ekstensi file. Tidak didukung saat mengimpor dari OneDrive for Business. Untuk mengimpor atau membuat aliran data, parameter ini harus dikodekan secara permanen ke model.json.
nameConflict	query		ImportConflictHandlerMode	Menentukan apa yang harus dilakukan jika himpunan data dengan nama yang sama sudah ada. Nilai defaultnya adalah `Ignore`. Untuk file RDL, `Abort` dan `Overwrite` merupakan satu-satunya opsi yang didukung. Untuk file model.json aliran data, `Abort` dan `GenerateUniqueName` merupakan satu-satunya opsi yang didukung.
overrideModelLabel	query		boolean	Menentukan apakah akan mengambil alih label yang ada pada model saat menerbitkan ulang file .pbix Power BI. Nilai default layanan adalah `true`.
overrideReportLabel	query		boolean	Apakah akan mengambil alih label yang ada pada laporan saat menerbitkan ulang file .pbix Power BI. Nilai default layanan adalah `true`.
skipReport	query		boolean	Apakah akan melewati impor laporan. Jika ditentukan, nilainya harus `true`. Hanya didukung untuk file .pbix Power BI.
subfolderObjectId	query		string uuid	ID subfolder untuk mengimpor file ke subfolder.

Isi Permintaan

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

Nama	Jenis	Deskripsi
connectionType	connectionType	Tipe koneksi impor untuk file OneDrive for Business
filePath	string	Jalur file OneDrive for Business Excel (.xlsx) untuk diimpor, yang bisa absolut atau relatif. File .pbix Power BI tidak didukung.
fileUrl	string	URL tanda tangan akses bersama dari penyimpanan blob sementara yang digunakan untuk mengimpor file .pbix Power BI besar antara ukuran 1 GB dan 10 GB.

Respons

Nama	Jenis	Deskripsi
200 OK	Import	OK
202 Accepted	Import	Diterima

Contoh

Import dataflow model.json example

Post import example

Post import skip report example

Import dataflow model.json example

Permintaan sampel

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True

Isi Permintaan

{
  "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--"
}

Respon sampel

Kode status:: 202

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

Post import example

Permintaan sampel

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore

Isi Permintaan

{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Respon sampel

Kode status:: 202

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

Post import skip report example

Permintaan sampel

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

Isi Permintaan

{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Respon sampel

Kode status:: 202

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

Definisi

Nama	Deskripsi
connectionType	Tipe koneksi impor untuk file OneDrive for Business
Dataset	Himpunan data Power BI. API mengembalikan subset dari daftar properti himpunan data berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.
DatasetQueryScaleOutSettings	Pengaturan peluasan skala kueri himpunan data
DatasetUser	Entri kanan akses pengguna Power BI untuk himpunan data
DatasetUserAccessRight	Hak akses yang dimiliki pengguna untuk himpunan data (tingkat izin)
DependentDataflow	Aliran data dependen Power BI
Encryption	Informasi enkripsi untuk himpunan data
EncryptionStatus	Status enkripsi himpunan data
Import	Objek impor
ImportConflictHandlerMode	Menentukan apa yang harus dilakukan jika himpunan data dengan nama yang sama sudah ada. Nilai defaultnya adalah `Ignore`. Untuk file RDL, `Abort` dan `Overwrite` merupakan satu-satunya opsi yang didukung. Untuk aliran data model.json file, `Abort` dan `GenerateUniqueName` merupakan satu-satunya opsi yang didukung.
ImportInfo	Informasi tentang impor
PrincipalType	Jenis utama
Report	Laporan Power BI. API mengembalikan subset dari daftar properti laporan berikut. Subset bergantung pada API yang disebut, izin penelepon, dan ketersediaan data dalam database Power BI.
ReportUser	Entri kanan akses pengguna Power BI untuk laporan
ReportUserAccessRight	Hak akses yang dimiliki pengguna untuk laporan (tingkat izin)
ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
Subscription	Langganan email untuk item Power BI (seperti laporan atau dasbor)
SubscriptionUser	Pengguna langganan email Power BI

connectionType

Tipe koneksi impor untuk file OneDrive for Business

Nama	Jenis	Deskripsi
connect	string
import	string

Dataset

Himpunan data Power BI. API mengembalikan subset dari daftar properti himpunan data berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.

Nama	Jenis	Deskripsi
ContentProviderType	string	Jenis penyedia konten untuk himpunan data
CreateReportEmbedURL	string	URL semat laporan pembuatan himpunan data
CreatedDate	string	Tanggal dan waktu pembuatan himpunan data
Encryption	Encryption	Informasi enkripsi himpunan data. Hanya berlaku ketika `$expand` ditentukan.
IsEffectiveIdentityRequired	boolean	Apakah himpunan data memerlukan identitas yang efektif, yang harus Anda kirim dalam panggilan GENERATEToken API.
IsEffectiveIdentityRolesRequired	boolean	Apakah keamanan tingkat baris ditentukan di dalam file .pbix Power BI. Jika demikian, Anda harus menentukan peran.
IsInPlaceSharingEnabled	boolean	Apakah himpunan data dapat dibagikan dengan pengguna eksternal untuk dikonsumsi di penyewa mereka sendiri
IsOnPremGatewayRequired	boolean	Apakah himpunan data memerlukan gateway data lokal
IsRefreshable	boolean	Apakah himpunan data dapat disegarkan atau tidak. Himpunan data yang dapat disegarkan Power BI adalah himpunan data yang telah di-refresh setidaknya sekali, atau di mana jadwal refresh yang valid ada.
QnaEmbedURL	string	Himpunan data Q&URL semat
addRowsAPIEnabled	boolean	Apakah himpunan data memungkinkan penambahan baris baru
configuredBy	string	Pemilik himpunan data
description	string	Deskripsi himpunan data
id	string	ID himpunan data
name	string	Nama himpunan data
queryScaleOutSettings	DatasetQueryScaleOutSettings	Pengaturan peluasan skala kueri himpunan data
targetStorageMode	string	Mode penyimpanan himpunan data
upstreamDataflows	DependentDataflow[]	Daftar semua aliran data yang bergantung pada item ini
users	DatasetUser[]	(Nilai kosong) Detail akses pengguna himpunan data. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna tentang item Power BI (seperti laporan atau dasbor) dengan menggunakan Get Dataset Users as Admin API, atau PostWorkspaceInfo API dengan `getArtifactUsers` parameter .
webUrl	string	URL web himpunan data

DatasetQueryScaleOutSettings

Pengaturan peluasan skala kueri himpunan data

Nama	Jenis	Deskripsi
autoSyncReadOnlyReplicas	boolean	Apakah himpunan data secara otomatis menyinkronkan replika baca-saja
maxReadOnlyReplicas	integer	Jumlah maksimum replika baca-saja untuk himpunan data (0-64, -1 untuk jumlah replika otomatis)

DatasetUser

Entri kanan akses pengguna Power BI untuk himpunan data

Nama	Jenis	Deskripsi
datasetUserAccessRight	DatasetUserAccessRight	Hak akses yang dimiliki pengguna untuk himpunan data (tingkat izin)
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
userType	string	Jenis pengguna.

DatasetUserAccessRight

Hak akses yang dimiliki pengguna untuk himpunan data (tingkat izin)

Nama	Jenis	Deskripsi
None	string	Menghapus izin ke konten dalam himpunan data
Read	string	Memberikan akses Baca ke konten dalam himpunan data
ReadExplore	string	Memberikan akses Baca dan Jelajahi ke konten dalam himpunan data
ReadReshare	string	Memberikan akses Baca dan Reshare ke konten dalam himpunan data
ReadReshareExplore	string	Memberikan akses Baca, Reshare, dan Jelajahi ke konten dalam himpunan data
ReadWrite	string	Memberikan akses Baca dan Tulis ke konten dalam himpunan data
ReadWriteExplore	string	Memberikan akses Baca, Tulis, dan Jelajahi ke konten dalam himpunan data
ReadWriteReshare	string	Memberikan akses Baca, Tulis, dan Reshare ke konten dalam himpunan data
ReadWriteReshareExplore	string	Memberikan akses Baca, Tulis, Reshare, dan Jelajahi konten dalam himpunan data

DependentDataflow

Aliran data dependen Power BI

Nama	Jenis	Deskripsi
groupId	string	ID grup target
targetDataflowId	string	ID aliran data target

Encryption

Informasi enkripsi untuk himpunan data

Nama	Jenis	Deskripsi
EncryptionStatus	EncryptionStatus	Status enkripsi himpunan data

EncryptionStatus

Status enkripsi himpunan data

Nama	Jenis	Deskripsi
InSyncWithWorkspace	string	Enkripsi didukung dan sinkron dengan pengaturan enkripsi
NotInSyncWithWorkspace	string	Enkripsi didukung tetapi tidak sinkron dengan pengaturan enkripsi
NotSupported	string	Enkripsi tidak didukung untuk himpunan data ini
Unknown	string	Status enkripsi tidak diketahui karena kerusakan himpunan data

Import

Objek impor

Nama	Jenis	Deskripsi
createdDateTime	string	Impor tanggal dan waktu pembuatan
datasets	Dataset[]	Himpunan data yang terkait dengan impor ini
id	string	ID impor
importState	enum: Failed Publishing Succeeded	Status unggahan impor
name	string	Nama impor
reports	Report[]	Laporan yang terkait dengan impor ini
updatedDateTime	string	Impor tanggal dan waktu pembaruan terakhir

ImportConflictHandlerMode

Menentukan apa yang harus dilakukan jika himpunan data dengan nama yang sama sudah ada. Nilai defaultnya adalah Ignore. Untuk file RDL, Abort dan Overwrite merupakan satu-satunya opsi yang didukung. Untuk aliran data model.json file, Abort dan GenerateUniqueName merupakan satu-satunya opsi yang didukung.

Nama	Jenis	Deskripsi
Abort	string	Jika himpunan data atau aliran data dengan nama yang sama sudah ada, operasi impor akan dibatalkan.
CreateOrOverwrite	string	Jika himpunan data dengan nama yang sama sudah ada, operasi impor akan mengganti himpunan data yang ada dengan yang baru. Operasi impor akan gagal jika ada lebih dari satu himpunan data yang ada dengan nama yang sama.
GenerateUniqueName	string	Jika aliran data dengan nama yang sama sudah ada, operasi impor akan menghasilkan nama unik baru untuk aliran data baru.
Ignore	string	Jika himpunan data dengan nama yang sama sudah ada, operasi impor akan membuat himpunan data baru dengan nama yang sama.
Overwrite	string	Jika himpunan data dengan nama yang sama sudah ada, operasi impor akan mengganti himpunan data yang ada dengan yang baru. Operasi impor akan gagal jika tidak ada konflik atau jika ada lebih dari satu himpunan data yang ada dengan nama yang sama.

ImportInfo

Informasi tentang impor

Nama	Jenis	Deskripsi
connectionType	connectionType	Tipe koneksi impor untuk file OneDrive for Business
filePath	string	Jalur file OneDrive for Business Excel (.xlsx) untuk diimpor, yang bisa absolut atau relatif. File .pbix Power BI tidak didukung.
fileUrl	string	URL tanda tangan akses bersama dari penyimpanan blob sementara yang digunakan untuk mengimpor file .pbix Power BI besar antara ukuran 1 GB dan 10 GB.

PrincipalType

Jenis utama

Nama	Jenis	Deskripsi
App	string	Jenis perwakilan layanan
Group	string	Jenis utama grup
None	string	Tidak ada jenis utama. Gunakan untuk seluruh akses tingkat organisasi.
User	string	Jenis prinsipal pengguna

Report

Laporan Power BI. API mengembalikan subset dari daftar properti laporan berikut. Subset bergantung pada API yang disebut, izin penelepon, dan ketersediaan data dalam database Power BI.

Nama	Jenis	Deskripsi
appId	string	ID aplikasi, dikembalikan hanya jika laporan milik aplikasi
datasetId	string	ID himpunan data laporan
description	string	Deskripsi laporan
embedUrl	string	URL laporan yang disematkan
id	string	ID laporan
isOwnedByMe	boolean	Tentukan apakah laporan dibuat oleh pengguna saat ini.
name	string	Nama laporan
originalReportId	string	ID laporan aktual saat ruang kerja diterbitkan sebagai aplikasi.
reportType	enum: PaginatedReport PowerBIReport	Jenis laporan
subscriptions	Subscription[]	(Nilai Kosong) Detail langganan untuk item Power BI (seperti laporan atau dasbor). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda bisa mengambil informasi langganan untuk laporan Power BI dengan menggunakan Langganan Dapatkan Laporan sebagai panggilan API Admin.
users	ReportUser[]	(Nilai kosong) Detail akses pengguna untuk laporan Power BI. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna pada laporan Power BI dengan menggunakan panggilan Get Report Users as Admin API, atau panggilan API PostWorkspaceInfo dengan `getArtifactUsers` parameter .
webUrl	string	URL web laporan

ReportUser

Entri kanan akses pengguna Power BI untuk laporan

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	Hak akses yang dimiliki pengguna untuk laporan (tingkat izin)
userType	string	Jenis pengguna.

ReportUserAccessRight

Hak akses yang dimiliki pengguna untuk laporan (tingkat izin)

Nama	Jenis	Deskripsi
None	string	Tidak ada izin untuk konten dalam laporan
Owner	string	Memberikan akses Baca, Tulis, dan Reshare ke konten dalam laporan
Read	string	Memberikan akses Baca ke konten dalam laporan
ReadCopy	string	Memberikan akses Baca dan Salin ke konten dalam laporan
ReadReshare	string	Memberikan akses Baca dan Reshare ke konten dalam laporan
ReadWrite	string	Memberikan akses Baca dan Tulis ke konten dalam laporan

ServicePrincipalProfile

Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.

Nama	Jenis	Deskripsi
displayName	string	Nama profil perwakilan layanan
id	string	ID profil perwakilan layanan

Subscription

Langganan email untuk item Power BI (seperti laporan atau dasbor)

Nama	Jenis	Deskripsi
artifactDisplayName	string	Nama item Power BI langganan (seperti laporan atau dasbor)
artifactId	string	ID item Power BI langganan (seperti laporan atau dasbor)
artifactType	string	Jenis item Power BI (misalnya `Report`, , `Dashboard`atau `Dataset`)
attachmentFormat	string	Format laporan yang dilampirkan dalam langganan email
endDate	string	Tanggal dan waktu akhir langganan email
frequency	string	Frekuensi langganan email
id	string	ID langganan
isEnabled	boolean	Apakah langganan email diaktifkan
linkToContent	boolean	Apakah tautan langganan ada di langganan email
previewImage	boolean	Apakah cuplikan layar laporan ada di langganan email
startDate	string	Tanggal dan waktu mulai langganan email
subArtifactDisplayName	string	Nama halaman item Power BI langganan, jika itu adalah laporan.
title	string	Nama aplikasi
users	SubscriptionUser[]	Detail setiap pelanggan email. Saat menggunakan panggilan Get User Subscriptions As Admin API, nilai yang dikembalikan adalah array kosong (null). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi langganan pada laporan atau dasbor Power BI dengan menggunakan panggilan Dapatkan Langganan Laporan Sebagai Admin atau Dapatkan Langganan Dasbor Sebagai Admin API.

SubscriptionUser

Pengguna langganan email Power BI

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
userType	string	Jenis pengguna.

Bagikan melalui

Imports - Post Import In Group

Izin

Cakupan yang Diperlukan

Batasan

Parameter URI

Isi Permintaan

Respons

Contoh

Import dataflow model.json example

Permintaan sampel

Respon sampel

Post import example

Permintaan sampel

Respon sampel

Post import skip report example

Permintaan sampel

Respon sampel

Definisi

connectionType

Dataset

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

Import

ImportConflictHandlerMode

ImportInfo

PrincipalType

Report

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Sumber Daya Tambahan: