Push Datasets - Datasets PostDataset

Service:

Power BI REST APIs

API Version:

v1.0

Membuat himpunan data baru di Ruang kerja saya.

Cakupan yang Diperlukan

Dataset.ReadWrite.All

Batasan

Panggilan API ini hanya mendukung himpunan data push. Untuk daftar lengkap batasan, lihat Mendorong batasan himpunan data.

POST https://api.powerbi.com/v1.0/myorg/datasets

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
defaultRetentionPolicy	query		DefaultRetentionPolicy	Kebijakan retensi default

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string	Nama himpunan data
tables	True	Table[]	Tabel himpunan data
datasources		Datasource[]	Sumber data yang terkait dengan himpunan data ini
defaultMode		DatasetMode	Mode atau jenis himpunan data
relationships		Relationship[]	Hubungan himpunan data

Respons

Nama	Jenis	Deskripsi
201 Created	Dataset	Dibuat
202 Accepted	Dataset	Diterima

Contoh

Push example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

Request Body

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Sample Response

Status code:

201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Definisi

Nama	Deskripsi
ASMashupExpression	Sumber tabel himpunan data
Column	Kolom himpunan data
CreateDatasetRequest	Himpunan data Power BI
CrossFilteringBehavior	Arah filter hubungan
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.
DatasetMode	Mode atau jenis himpunan data
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)
Datasource	Sumber data Power BI
DatasourceConnectionDetails	Detail koneksi sumber data Power BI. Lihat contoh di Dapatkan Sumber Data atau Dapatkan Sumber Data Dalam Grup.
DefaultRetentionPolicy	Kebijakan retensi default
DependentDataflow	Aliran data dependen Power BI
Encryption	Informasi enkripsi untuk himpunan data
EncryptionStatus	Status enkripsi himpunan data
Measure	Pengukuran Power BI
PrincipalType	Jenis utama
Relationship	Hubungan antara tabel dalam himpunan data
Row	Baris data dalam himpunan data
ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
Table	Tabel himpunan data

ASMashupExpression

Sumber tabel himpunan data

Nama	Jenis	Deskripsi
expression	string	Ekspresi sumber

Column

Kolom himpunan data

Nama	Jenis	Deskripsi
dataCategory	string	Pilihan. Nilai string yang akan digunakan untuk kategori data yang menjelaskan data dalam kolom ini.
dataType	string	Jenis data kolom
formatString	string	Opsional. Format kolom seperti yang ditentukan dalam FORMAT_STRING.
isHidden	boolean	Pilihan. Apakah kolom disembunyikan. Defaultnya adalah false.
name	string	Nama kolom
sortByColumn	string	Pilihan. Nama string kolom dalam tabel yang sama untuk digunakan untuk mengurutkan kolom saat ini.
summarizeBy	string	Opsional. Fungsi agregat yang digunakan untuk meringkas kolom ini.

CreateDatasetRequest

Himpunan data Power BI

Nama	Jenis	Deskripsi
datasources	Datasource[]	Sumber data yang terkait dengan himpunan data ini
defaultMode	DatasetMode	Mode atau jenis himpunan data
name	string	Nama himpunan data
relationships	Relationship[]	Hubungan himpunan data
tables	Table[]	Tabel himpunan data

CrossFilteringBehavior

Arah filter hubungan

Nama	Jenis	Deskripsi
Automatic	string	Perilaku pemfilteran silang secara otomatis ditentukan
BothDirections	string	Untuk tujuan pemfilteran, kedua tabel diperlakukan sebagai tabel tunggal.
OneDirection	string	Untuk tujuan pemfilteran, filter akan diterapkan pada tabel tempat nilai diagregasi.

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

DatasetMode

Mode atau jenis himpunan data

Nama	Jenis	Deskripsi
AsAzure	string	Himpunan data dengan koneksi langsung ke Azure Analysis Services
AsOnPrem	string	Himpunan data dengan koneksi langsung ke Azure Analysis Services lokal
Push	string	Himpunan data yang memungkinkan akses terprogram untuk mendorong data ke Power BI
PushStreaming	string	Himpunan data yang mendukung streaming data dan memungkinkan akses terprogram untuk mendorong data ke Power BI
Streaming	string	Himpunan data yang mendukung streaming data. Untuk informasi selengkapnya, lihat Streaming real-time di Power BI.

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

Datasource

Sumber data Power BI

Nama	Jenis	Deskripsi
connectionDetails	DatasourceConnectionDetails	Detail koneksi sumber data
connectionString	string	(Tidak digunakan lagi) Sumber data string koneksi. Hanya tersedia untuk DirectQuery.
datasourceId	string	ID sumber data terikat, yang kosong saat tidak terikat ke gateway
datasourceType	string	Jenis sumber data
gatewayId	string	ID gateway terikat, yang kosong saat tidak terikat ke gateway. Saat menggunakan kluster gateway, ID gateway mengacu pada gateway utama (pertama) di kluster dan mirip dengan ID kluster gateway.
name	string	(Tidak digunakan lagi) Nama sumber data. Hanya tersedia untuk DirectQuery.

DatasourceConnectionDetails

Detail koneksi sumber data Power BI. Lihat contoh di Dapatkan Sumber Data atau Dapatkan Sumber Data Dalam Grup.

Nama	Jenis	Deskripsi
account	string	Akun koneksi
classInfo	string	Informasi kelas koneksi
database	string	Database koneksi
domain	string	Domain koneksi
emailAddress	string	Alamat email koneksi
kind	string	Jenis koneksi
loginServer	string	Server masuk koneksi
path	string	Jalur koneksi
server	string	Server koneksi
url	string	URL koneksi

DefaultRetentionPolicy

Kebijakan retensi default

Nama	Jenis	Deskripsi
None	string	Tidak ada
basicFIFO	string	basicFIFO

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

Measure

Pengukuran Power BI

Nama	Jenis	Deskripsi
description	string	Pilihan. Deskripsi pengukuran.
expression	string	Ekspresi DAX yang valid
formatString	string	Pilihan. String yang menjelaskan bagaimana nilai harus diformat saat ditampilkan seperti yang ditentukan dalam FORMAT_STRING.
isHidden	boolean	Pilihan. Apakah ukuran disembunyikan.
name	string	Nama pengukuran

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

Relationship

Hubungan antara tabel dalam himpunan data

Nama	Jenis	Nilai Default	Deskripsi
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Arah filter hubungan
fromColumn	string		Nama kolom kunci asing
fromTable	string		Nama tabel kunci asing
name	string		Nama dan pengidentifikasi hubungan
toColumn	string		Nama kolom kunci primer
toTable	string		Nama tabel kunci primer

Row

Baris data dalam himpunan data

Nama	Jenis	Deskripsi
id	string	ID baris unik

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

Table

Tabel himpunan data

Nama	Jenis	Deskripsi
columns	Column[]	Skema kolom untuk tabel ini
description	string	Deskripsi tabel
isHidden	boolean	Opsional. Apakah tabel himpunan data ini disembunyikan.
measures	Measure[]	Ukuran dalam tabel ini
name	string	Nama tabel
rows	Row[]	Baris data dalam tabel ini
source	ASMashupExpression[]	Sumber tabel