Reports - Export To File

Service:

Power BI REST APIs

API Version:

v1.0

Belirtilen raporu Çalışma alanım'dan istenen dosya biçimine aktarır.

API zaman uyumsuzdur. API çağrıldığında bir dışarı aktarma işi tetikler. Dışarı aktarma işini tetikledikten sonra, iş durumunu izlemek için GetExportToFileStatus API'sini kullanın. Akışın tamamı hakkında daha fazla bilgi edinin: Power BI raporlarını dışarı aktarma ve Sayfalandırılmış raporları dışarı aktarma

Gerekli Kapsam

Aşağıdakilerin tümü:

• Report.ReadWrite.All veya Report.Read.All
• Dataset.ReadWrite.All veya Dataset.Read.All

Sınırlamalar

Power BI raporunu dosyaya dışarı aktarma ve Sayfalandırılmış raporu dosyaya dışarı aktarma ile ilgili sınırlamaları denetleyin.

POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/ExportTo

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
reportId	path	True	string uuid	Rapor kimliği

İstek Gövdesi

Name	Gerekli	Tür	Description
format	True	FileFormat	Dışarı aktarılan dosya için istenen biçim
paginatedReportConfiguration		PaginatedReportExportConfiguration	Sayfalandırılmış raporu dışarı aktarmak için kullanılan yapılandırma
powerBIReportConfiguration		PowerBIReportExportConfiguration	Power BI raporunu dışarı aktarmak için kullanılan yapılandırma

Yanıtlar

Name	Tür	Description
202 Accepted	Export	Kabul edildi

Tanımlar

Name	Description
EffectiveIdentity	Kullanıcı kimliğini ve rollerini tanımlar. Daha fazla bilgi için bkz. Power BI Embedded ile satır düzeyi güvenlik.
Export	Dosya işine dışarı aktarma işleminin ayrıntılarını ve geçerli durumunu açıklayan nesne
ExportFilter	Dışarı aktarma işlemi sırasında uygulanacak filtre
ExportReportPage	Dışarı aktarma isteği için tek sayfalı yapılandırma
ExportReportRequest	Dosya isteğine dışarı aktarma
ExportReportSettings	Dosya isteği ayarlarına aktar
ExportState	Dosyaya dışarı aktarma işinin geçerli durumu
FileFormat	Dışarı aktarılan dosya için istenen biçim
IdentityBlob	Kimlik belirtmek için bir blob. Yalnızca Azure SQL DirectQuery bağlantısı olan veri kümeleri için desteklenir
PageBookmark	Tek bir sayfaya uygulanacak yer işareti. Ad veya durum belirtin, ancak ikisini birden sağlamaz.
PaginatedReportExportConfiguration	Sayfalandırılmış rapor için dosyaya aktarma yapılandırması
ParameterValue	Sayfalandırılmış rapor parametreleri için veri sözleşmesi
PowerBIReportExportConfiguration	Power BI raporunun dosyaya aktarma yapılandırması

EffectiveIdentity

Kullanıcı kimliğini ve rollerini tanımlar. Daha fazla bilgi için bkz. Power BI Embedded ile satır düzeyi güvenlik.

Name	Tür	Description
auditableContext	string	EffectiveIdentity denetlenebilir bağlamı. Bu parametre sağlanır ve boş değilse EffectiveIdentity denetimini etkinleştirir ve değeri denetim kaydındaki kullanıcı adına ayarlanır. Aksi takdirde EffectiveIdentity bağlamı GenerateToken denetim kaydından atlanır.
customData	string	Satır düzeyi güvenlik kurallarını uygulamak için kullanılan özel veriler. Yalnızca Azure Analysis Services modellerine ve bulut modellerine canlı bağlantı için desteklenir.
datasets	string[]	Bu kimliğin geçerli olduğu bir veri kümesi dizisi
identityBlob	IdentityBlob	Kimliği belirten bir blob. Yalnızca Azure SQL DirectQuery bağlantısı olan veri kümeleri için desteklenir.
reports	string[]	Bu kimliğin geçerli olduğu bir rapor dizisi. Yalnızca sayfalandırılmış raporlar için desteklenir.
roles	string[]	RLS kurallarını uygulayan bir belirteç içindeki satır düzeyi güvenlik (RLS) rolleri dizisi. Bir kimlik en fazla 50 rol içerebilir. Bir rol dışında ,herhangi bir karakter içerebilir ve uzunluğu 50 karakteri aşmamalıdır.
username	string	Satır düzeyi güvenlik kuralları uygulayan bir belirteç içindeki geçerli kullanıcı adı. Şirket içi model için kullanıcı adı alfasayısal veya şu karakterlerden .herhangi birini içerebilir: , -, !_, , #, ^, ~, , \\, . @ Bulut modelleri için kullanıcı adı herhangi bir ASCII karakteri içerebilir. Her iki model için de kullanıcı adı uzunluğu 256 karakteri aşmamalıdır ve kullanıcı adı boşluk içermemelidir.

Export

Dosya işine dışarı aktarma işleminin ayrıntılarını ve geçerli durumunu açıklayan nesne

Name	Tür	Description
ResourceFileExtension	string	Dışarı aktarılan dosyanın uzantısı
createdDateTime	string	Dosya işine dışarı aktarma işleminin başlangıç tarihi ve saati
expirationTime	string	Alma URL'sinin son kullanma tarihi ve saati
id	string	Dosyaya dışarı aktarma işi kimliği
lastActionDateTime	string	Dosyaya dışarı aktarma işinde yapılan son değişikliğin tarihi ve saati
percentComplete	integer	Yüzde olarak iş ilerleme durumu
reportId	string	Dışarı aktarılan raporun kimliği
reportName	string	Dışarı aktarılan raporun adı
resourceLocation	string	Dışarı aktarılan dosyanın alma URL'si
status	ExportState	Dosyaya dışarı aktarma işinin geçerli durumu

ExportFilter

Dışarı aktarma işlemi sırasında uygulanacak filtre

Name	Tür	Description
filter	string	Uygulanacak filtre. Filtre söz dizimi hakkında bilgi için bkz. Rapora filtre uygulama.

ExportReportPage

Dışarı aktarma isteği için tek sayfalı yapılandırma

Name	Tür	Description
bookmark	PageBookmark	Sayfaya uygulanacak yer işareti
pageName	string	Sayfa adı
visualName	string	Dışarı aktaracak görselin adı. Bu sayfadaki tek bir görselin dışarı aktarılmış olması durumunda bir ad belirtin.

ExportReportRequest

Dosya isteğine dışarı aktarma

Name	Tür	Description
format	FileFormat	Dışarı aktarılan dosya için istenen biçim
paginatedReportConfiguration	PaginatedReportExportConfiguration	Sayfalandırılmış raporu dışarı aktarmak için kullanılan yapılandırma
powerBIReportConfiguration	PowerBIReportExportConfiguration	Power BI raporunu dışarı aktarmak için kullanılan yapılandırma

ExportReportSettings

Dosya isteği ayarlarına aktar

Name	Tür	Description
includeHiddenPages	boolean	Raporun tamamını dışarı aktarırken gizli sayfaların dahil edilip edilmeyeceği. Sağlanmadıysa, varsayılan davranış gizli sayfaları dışlamaktır. Belirli sayfalar dışarı aktarıldığında bu özellik yoksayılır.
locale	string	Uygulanacak yerel ayar

ExportState

Dosyaya dışarı aktarma işinin geçerli durumu

Name	Tür	Description
Failed	string	Dosyaya aktarma işi başarısız oldu
NotStarted	string	Dosyaya aktarma işi başlamadı
Running	string	Dosyaya aktarma işi çalışıyor
Succeeded	string	Dosyaya aktarma işi başarıyla tamamlandı
Undefined	string	Dosyaya dışarı aktarma işinin durumu tanımsız

FileFormat

Dışarı aktarılan dosya için istenen biçim

Name	Tür	Description
ACCESSIBLEPDF	string	Erişilebilir PDF (yalnızca sayfalandırılmış raporlar için desteklenir)
CSV	string	CSV (yalnızca sayfalandırılmış raporlar için desteklenir)
DOCX	string	Microsoft Word (yalnızca sayfalandırılmış raporlar için desteklenir)
IMAGE	string	BMP, EMF, GIF, JPEG, PNG veya TIFF görüntü biçimleri (yalnızca sayfalandırılmış raporlar için desteklenir)
MHTML	string	MHTML (yalnızca sayfalandırılmış raporlar için desteklenir)
PDF	string	PDF
PNG	string	PNG (yalnızca Power BI raporları için desteklenir)
PPTX	string	Microsoft PowerPoint
XLSX	string	Microsoft Excel (yalnızca sayfalandırılmış raporlar için desteklenir)
XML	string	XML (yalnızca sayfalandırılmış raporlar için desteklenir)

IdentityBlob

Kimlik belirtmek için bir blob. Yalnızca Azure SQL DirectQuery bağlantısı olan veri kümeleri için desteklenir

Name	Tür	Description
value	string	Azure SQL için OAuth 2.0 erişim belirteci

PageBookmark

Tek bir sayfaya uygulanacak yer işareti. Ad veya durum belirtin, ancak ikisini birden sağlamaz.

Name	Tür	Description
name	string	Yer işareti adı
state	string	Yer işareti durumu

PaginatedReportExportConfiguration

Sayfalandırılmış rapor için dosyaya aktarma yapılandırması

Name	Tür	Description
formatSettings	object	Biçim ayarları sözlüğü. Anahtarlar, istenen dosya biçimi için cihaz bilgileri özellik adlarıdır.
identities	EffectiveIdentity[]	Raporu dışarı aktarırken kullanılacak tek kimlik. Bir rapor Power BI veri kümesi veya Azure Analysis Services veri kaynağı kullandığında gereklidir.
parameterValues	ParameterValue[]	Rapor parametrelerinin listesi

ParameterValue

Sayfalandırılmış rapor parametreleri için veri sözleşmesi

Name	Tür	Description
name	string	Parametre adı
value	string	Parametre değeri

PowerBIReportExportConfiguration

Power BI raporunun dosyaya aktarma yapılandırması

Name	Tür	Description
datasetToBind	string	Raporu dışarı aktarmak için veri kümesi kimliği. Yalnızca raporun varsayılan veri kümesi dışında bir veri kümesiyle dışarı aktarma işlemi için gereklidir.
defaultBookmark	PageBookmark	Belirli bir yer işareti olmayan tüm sayfalara uygulanacak varsayılan yer işareti
identities	EffectiveIdentity[]	Satır düzeyi güvenlik kuralları için kullanılacak kimliklerin listesi
pages	ExportReportPage[]	Dışarı aktaracak sayfaların listesi ve bunların özellikleri. Aynı sayfa farklı görsellerle birden çok kez görünebilir.
reportLevelFilters	ExportFilter[]	Uygulanacak rapor düzeyi filtrelerinin listesi. Şu anda yalnızca bir filtre desteklenmektedir.
settings	ExportReportSettings	Dosyaya aktarma işi için uygulanacak ayarlar