Reports - Export To File
지정된 보고서를 내 작업 영역에서 요청된 파일 형식으로 내보냅니다.
이 API는 비동기식입니다. API가 호출되면 내보내기 작업이 트리거됩니다. 내보내기 작업을 트리거한 후 GetExportToFileStatus API를 사용하여 작업 상태 추적합니다. 전체 흐름에 대해 자세히 알아보기: Power BI 보고서 내보내기 및 페이지를 매긴 보고서 내보내기
필수 범위
다음을 모두 수행합니다.
- Report.ReadWrite.All 또는 Report.Read.All
- Dataset.ReadWrite.All 또는 Dataset.Read.All
제한 사항
Power BI 보고서를 파일로 내보내기 및 페이지를 매긴 보고서를 파일로 내보내기의 제한 사항을 확인합니다.
POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/ExportToURI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
report
|
path | True |
string uuid |
보고서 ID |
요청 본문
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| format | True |
내보낸 파일에 대해 요청된 형식 |
|
| paginatedReportConfiguration |
페이지를 매긴 보고서를 내보내는 데 사용되는 구성 |
||
| powerBIReportConfiguration |
Power BI 보고서를 내보내는 데 사용되는 구성 |
응답
| Name | 형식 | Description |
|---|---|---|
| 202 Accepted |
수락됨 |
정의
| Name | Description |
|---|---|
|
Effective |
사용자 ID 및 역할을 정의합니다. 자세한 내용은 Power BI Embedded 행 수준 보안을 참조하세요. |
| Export |
파일로 내보내기 작업의 세부 정보 및 현재 상태를 설명하는 개체입니다. |
|
Export |
내보내기 작업 중에 적용할 필터 |
|
Export |
내보내기 요청에 대한 단일 페이지 구성 |
|
Export |
파일로 내보내기 요청 |
|
Export |
파일 요청 설정으로 내보내기 |
|
Export |
파일로 내보내기 작업의 현재 상태입니다. |
|
File |
내보낸 파일에 대해 요청된 형식 |
|
Identity |
ID를 지정하기 위한 Blob입니다. Azure SQL DirectQuery 연결이 있는 데이터 세트에 대해서만 지원됩니다. |
|
Page |
단일 페이지에 적용할 책갈피입니다. 이름 또는 상태를 제공하지만 둘 다 제공하지는 않습니다. |
|
Paginated |
페이지를 매긴 보고서의 파일로 내보내기 구성 |
|
Parameter |
페이지를 매긴 보고서 매개 변수에 대한 데이터 계약 |
|
Power |
Power BI 보고서에 대한 파일 구성으로 내보내기 |
EffectiveIdentity
사용자 ID 및 역할을 정의합니다. 자세한 내용은 Power BI Embedded 행 수준 보안을 참조하세요.
| Name | 형식 | Description |
|---|---|---|
| auditableContext |
string |
EffectiveIdentity 감사 가능한 컨텍스트입니다. 이 매개 변수가 제공되고 비어 있지 않으면 EffectiveIdentity에 대한 감사를 사용하도록 설정하고 해당 값은 감사 레코드의 사용자 이름으로 설정됩니다. 그렇지 않으면 EffectiveIdentity 컨텍스트가 GenerateToken 감사 레코드에서 생략됩니다. |
| customData |
string |
행 수준 보안 규칙을 적용하는 데 사용되는 사용자 지정 데이터입니다. Azure Analysis Services 모델 및 클라우드 모델에 대한 라이브 연결에만 지원됩니다. |
| datasets |
string[] |
이 ID가 적용되는 데이터 세트의 배열 |
| identityBlob |
ID를 지정하는 Blob 입니다. Azure SQL DirectQuery 연결이 있는 데이터 세트에 대해서만 지원됩니다. |
|
| reports |
string[] |
이 ID가 적용되는 보고서 배열입니다. 페이지를 매긴 보고서에 대해서만 지원됩니다. |
| roles |
string[] |
RLS 규칙을 적용하는 토큰 내의 RLS(행 수준 보안) 역할 배열입니다. ID에는 최대 50개의 역할이 포함될 수 있습니다. 역할에는 를 제외한 |
| username |
string |
행 수준 보안 규칙을 적용하는 토큰 내의 유효 사용자 이름입니다. 온-프레미스 모델의 경우 사용자 이름에는 영숫자 또는 다음 문자 |
Export
파일로 내보내기 작업의 세부 정보 및 현재 상태를 설명하는 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| ResourceFileExtension |
string |
내보낸 파일의 확장명입니다. |
| createdDateTime |
string |
파일로 내보내기 작업의 시작 날짜 및 시간 |
| expirationTime |
string |
검색 URL의 만료 날짜 및 시간 |
| id |
string |
파일로 내보내기 작업 ID |
| lastActionDateTime |
string |
파일로 내보내기 작업에 대한 마지막 변경 날짜 및 시간입니다. |
| percentComplete |
integer |
백분율로 작업 진행률 |
| reportId |
string |
내보낸 보고서의 ID |
| reportName |
string |
내보낸 보고서의 이름 |
| resourceLocation |
string |
내보낸 파일의 검색 URL |
| status |
파일로 내보내기 작업의 현재 상태입니다. |
ExportFilter
내보내기 작업 중에 적용할 필터
| Name | 형식 | Description |
|---|---|---|
| filter |
string |
적용할 필터입니다. 필터 구문에 대한 자세한 내용은 보고서 필터링을 참조하세요. |
ExportReportPage
내보내기 요청에 대한 단일 페이지 구성
| Name | 형식 | Description |
|---|---|---|
| bookmark |
페이지에 적용할 책갈피 |
|
| pageName |
string |
페이지 이름 |
| visualName |
string |
내보낼 시각적 개체의 이름입니다. 이 페이지의 단일 시각적 개체만 내보낼 경우 이름을 지정합니다. |
ExportReportRequest
파일로 내보내기 요청
| Name | 형식 | Description |
|---|---|---|
| format |
내보낸 파일에 대해 요청된 형식 |
|
| paginatedReportConfiguration |
페이지를 매긴 보고서를 내보내는 데 사용되는 구성 |
|
| powerBIReportConfiguration |
Power BI 보고서를 내보내는 데 사용되는 구성 |
ExportReportSettings
파일 요청 설정으로 내보내기
| Name | 형식 | Description |
|---|---|---|
| includeHiddenPages |
boolean |
전체 보고서를 내보낼 때 숨겨진 페이지를 포함할지 여부입니다. 제공되지 않은 경우 기본 동작은 숨겨진 페이지를 제외하는 것입니다. 이 속성은 특정 페이지를 내보낼 때 무시됩니다. |
| locale |
string |
적용할 로캘 |
ExportState
파일로 내보내기 작업의 현재 상태입니다.
| Name | 형식 | Description |
|---|---|---|
| Failed |
string |
파일로 내보내기 작업이 실패했습니다. |
| NotStarted |
string |
파일로 내보내기 작업이 시작되지 않았습니다. |
| Running |
string |
파일로 내보내기 작업이 실행 중입니다. |
| Succeeded |
string |
파일로 내보내기 작업이 성공적으로 완료되었습니다. |
| Undefined |
string |
파일로 내보내기 작업의 상태가 정의되지 않음 |
FileFormat
내보낸 파일에 대해 요청된 형식
| Name | 형식 | Description |
|---|---|---|
| ACCESSIBLEPDF |
string |
액세스 가능한 PDF(페이지를 매긴 보고서에만 지원됨) |
| CSV |
string |
CSV(페이지를 매긴 보고서에만 지원됨) |
| DOCX |
string |
Microsoft Word(페이지를 매긴 보고서에만 지원됨) |
| IMAGE |
string |
BMP, EMF, GIF, JPEG, PNG 또는 TIFF 이미지 형식(페이지를 매긴 보고서에만 지원됨) |
| MHTML |
string |
MHTML(페이지를 매긴 보고서에만 지원됨) |
|
string |
|
|
| PNG |
string |
PNG(Power BI 보고서에만 지원됨) |
| PPTX |
string |
Microsoft PowerPoint |
| XLSX |
string |
Microsoft Excel(페이지를 매긴 보고서에만 지원됨) |
| XML |
string |
XML(페이지를 매긴 보고서에만 지원됨) |
IdentityBlob
ID를 지정하기 위한 Blob입니다. Azure SQL DirectQuery 연결이 있는 데이터 세트에 대해서만 지원됩니다.
| Name | 형식 | Description |
|---|---|---|
| value |
string |
Azure SQL 대한 OAuth 2.0 액세스 토큰 |
PageBookmark
단일 페이지에 적용할 책갈피입니다. 이름 또는 상태를 제공하지만 둘 다 제공하지는 않습니다.
| Name | 형식 | Description |
|---|---|---|
| name |
string |
책갈피 이름 |
| state |
string |
책갈피 상태 |
PaginatedReportExportConfiguration
페이지를 매긴 보고서의 파일로 내보내기 구성
| Name | 형식 | Description |
|---|---|---|
| formatSettings |
object |
형식 설정의 사전입니다. 키는 요청된 파일 형식의 디바이스 정보 속성 이름입니다. |
| identities |
보고서를 내보낼 때 사용할 단일 ID입니다. 보고서에서 Power BI 데이터 세트 또는 Azure Analysis Services 데이터 원본을 사용하는 경우에 필요합니다. |
|
| parameterValues |
보고서 매개 변수 목록 |
ParameterValue
페이지를 매긴 보고서 매개 변수에 대한 데이터 계약
| Name | 형식 | Description |
|---|---|---|
| name |
string |
매개 변수 이름 |
| value |
string |
매개 변수 값 |
PowerBIReportExportConfiguration
Power BI 보고서에 대한 파일 구성으로 내보내기
| Name | 형식 | Description |
|---|---|---|
| datasetToBind |
string |
보고서를 내보낼 데이터 세트 ID입니다. 보고서의 기본 데이터 세트가 아닌 데이터 세트를 사용하여 내보내는 경우에만 필요합니다. |
| defaultBookmark |
특정 책갈피가 없는 모든 페이지에 적용할 기본 책갈피 |
|
| identities |
행 수준 보안 규칙에 사용할 ID 목록 |
|
| pages |
내보낼 페이지 목록 및 해당 속성입니다. 동일한 페이지가 여러 시각적 개체와 함께 두 번 이상 나타날 수 있습니다. |
|
| reportLevelFilters |
적용할 보고서 수준 필터 목록입니다. 현재는 하나의 필터만 지원됩니다. |
|
| settings |
파일로 내보내기 작업에 적용할 설정 |