Reports - Export To File

Service:

Power BI REST APIs

API Version:

v1.0

Exporta el informe especificado de Mi área de trabajo al formato de archivo solicitado.

La API es asincrónica. Cuando se llama a la API, desencadena un trabajo de exportación. Después de desencadenar un trabajo de exportación, use getExportToFileStatus API para realizar un seguimiento del estado del trabajo. Más información sobre todo el flujo: Exportación de informes de Power BI y Exportación de informes paginados

Ámbito requerido

Todo lo siguiente:

• Report.ReadWrite.All o Report.Read.All
• Dataset.ReadWrite.All o Dataset.Read.All

Limitaciones

Compruebe las limitaciones de Exportación del informe de Power BI al archivo y Exportación del informe paginado al archivo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
reportId	path	True	string uuid	El identificador del informe

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
format	True	FileFormat	El formato solicitado para el archivo exportado
paginatedReportConfiguration		PaginatedReportExportConfiguration	Configuración usada para exportar un informe paginado
powerBIReportConfiguration		PowerBIReportExportConfiguration	Configuración usada para exportar un informe de Power BI

Respuestas

Nombre	Tipo	Description
202 Accepted	Export	Aceptado

Definiciones

Nombre	Description
EffectiveIdentity	Define la identidad y los roles de usuario. Para obtener más información, consulte Seguridad de nivel de fila con Power BI Embedded.
Export	Objeto que describe los detalles y el estado actual de una exportación a un trabajo de archivo.
ExportFilter	Filtro que se va a aplicar durante la operación de exportación.
ExportReportPage	Configuración de una sola página para la solicitud de exportación
ExportReportRequest	Exportación a solicitud de archivo
ExportReportSettings	Exportar a la configuración de la solicitud de archivo
ExportState	Estado actual del trabajo de exportación a archivo
FileFormat	El formato solicitado para el archivo exportado
IdentityBlob	Un blob para especificar una identidad. Solo se admite para conjuntos de datos con una conexión directQuery a Azure SQL
PageBookmark	Marcador que se va a aplicar en una sola página. Proporcione el nombre o el estado, pero no ambos.
PaginatedReportExportConfiguration	La exportación a la configuración de archivos de un informe paginado
ParameterValue	Contrato de datos para parámetros de informe paginados
PowerBIReportExportConfiguration	La exportación a la configuración de archivos de un informe de Power BI

EffectiveIdentity

Define la identidad y los roles de usuario. Para obtener más información, consulte Seguridad de nivel de fila con Power BI Embedded.

Nombre	Tipo	Description
auditableContext	string	Contexto auditable EffectiveIdentity. Si se proporciona este parámetro y no está vacío, habilitará la auditoría de EffectiveIdentity y su valor se establecerá en el nombre de usuario en el registro de auditoría. De lo contrario, se omitirá el contexto EffectiveIdentity del registro de auditoría GenerateToken.
customData	string	Datos personalizados que se usan para aplicar reglas de seguridad de nivel de fila. Solo se admite para la conexión dinámica a modelos de Azure Analysis Services y modelos en la nube.
datasets	string[]	Matriz de conjuntos de datos para los que se aplica esta identidad
identityBlob	IdentityBlob	Un blob que especifica una identidad. Solo se admite para conjuntos de datos con una conexión directQuery a Azure SQL.
reports	string[]	Matriz de informes para los que se aplica esta identidad. Solo se admite para informes paginados.
roles	string[]	Matriz de roles de seguridad de nivel de fila (RLS) dentro de un token que aplica reglas de RLS. Una identidad puede contener hasta 50 roles. Un rol puede contener cualquier carácter excepto ,, y su longitud no debe superar los 50 caracteres.
username	string	Nombre de usuario efectivo dentro de un token que aplica reglas de seguridad de nivel de fila. Para un modelo local, el nombre de usuario puede contener caracteres alfanuméricos o cualquiera de los caracteres .siguientes, , _-, !, #^, , ~, , . @\\ En el caso de los modelos en la nube, el nombre de usuario puede contener cualquier carácter ASCII. Para cualquiera de los modelos, la longitud del nombre de usuario no debe superar los 256 caracteres y el nombre de usuario no debe contener espacios.

Export

Objeto que describe los detalles y el estado actual de una exportación a un trabajo de archivo.

Nombre	Tipo	Description
ResourceFileExtension	string	Extensión del archivo exportado
createdDateTime	string	Fecha y hora de inicio del trabajo de exportación a archivo
expirationTime	string	Fecha y hora de expiración de la dirección URL de recuperación
id	string	La exportación al identificador del trabajo de archivo
lastActionDateTime	string	Fecha y hora del último cambio en el trabajo de exportación a archivo
percentComplete	integer	Progreso del trabajo como porcentaje
reportId	string	El identificador del informe exportado
reportName	string	Nombre del informe exportado
resourceLocation	string	Dirección URL de recuperación del archivo exportado
status	ExportState	Estado actual del trabajo de exportación a archivo

ExportFilter

Filtro que se va a aplicar durante la operación de exportación.

Nombre	Tipo	Description
filter	string	El filtro que se va a aplicar. Para obtener información sobre la sintaxis de filtro, vea Filtrar un informe.

ExportReportPage

Configuración de una sola página para la solicitud de exportación

Nombre	Tipo	Description
bookmark	PageBookmark	Marcador que se va a aplicar en la página
pageName	string	El nombre de la página
visualName	string	Nombre del objeto visual que se va a exportar. Especifique un nombre, en caso de que solo se exporte un solo objeto visual de esta página.

ExportReportRequest

Exportación a solicitud de archivo

Nombre	Tipo	Description
format	FileFormat	El formato solicitado para el archivo exportado
paginatedReportConfiguration	PaginatedReportExportConfiguration	Configuración usada para exportar un informe paginado
powerBIReportConfiguration	PowerBIReportExportConfiguration	Configuración usada para exportar un informe de Power BI

ExportReportSettings

Exportar a la configuración de la solicitud de archivo

Nombre	Tipo	Description
includeHiddenPages	boolean	Si se deben incluir páginas ocultas al exportar un informe completo. Si no se proporciona, el comportamiento predeterminado es excluir páginas ocultas. Esta propiedad se omitirá cuando se exportan páginas específicas.
locale	string	Configuración regional que se va a aplicar

ExportState

Estado actual del trabajo de exportación a archivo

Nombre	Tipo	Description
Failed	string	Error en la exportación al trabajo de archivo
NotStarted	string	No se inició la exportación al trabajo de archivo
Running	string	Se está ejecutando la exportación al trabajo de archivo.
Succeeded	string	La exportación al trabajo de archivo finalizó correctamente
Undefined	string	El estado de la exportación al trabajo de archivo no está definido.

FileFormat

El formato solicitado para el archivo exportado

Nombre	Tipo	Description
ACCESSIBLEPDF	string	PDF accesible (solo se admite para informes paginados)
CSV	string	CSV (solo se admite para informes paginados)
DOCX	string	Microsoft Word (solo se admite para informes paginados)
IMAGE	string	Formatos de imagen BMP, EMF, GIF, JPEG, PNG o TIFF (solo se admiten para informes paginados)
MHTML	string	MHTML (solo se admite para informes paginados)
PDF	string	PDF
PNG	string	PNG (solo compatible con informes de Power BI)
PPTX	string	Microsoft PowerPoint
XLSX	string	Microsoft Excel (solo se admite para informes paginados)
XML	string	XML (solo se admite para informes paginados)

IdentityBlob

Un blob para especificar una identidad. Solo se admite para conjuntos de datos con una conexión directQuery a Azure SQL

Nombre	Tipo	Description
value	string	Un token de acceso de OAuth 2.0 para Azure SQL

PageBookmark

Marcador que se va a aplicar en una sola página. Proporcione el nombre o el estado, pero no ambos.

Nombre	Tipo	Description
name	string	El nombre del marcador
state	string	El estado del marcador

PaginatedReportExportConfiguration

La exportación a la configuración de archivos de un informe paginado

Nombre	Tipo	Description
formatSettings	object	Diccionario de configuraciones de formato. Las claves son los nombres de propiedad de información del dispositivo para el formato de archivo solicitado.
identities	EffectiveIdentity[]	Identidad única que se va a usar al exportar un informe. Necesario cuando un informe usa un conjunto de datos de Power BI o un origen de datos Azure Analysis Services.
parameterValues	ParameterValue[]	Una lista de parámetros de informe

ParameterValue

Contrato de datos para parámetros de informe paginados

Nombre	Tipo	Description
name	string	Nombre del parámetro
value	string	Valor del parámetro

PowerBIReportExportConfiguration

La exportación a la configuración de archivos de un informe de Power BI

Nombre	Tipo	Description
datasetToBind	string	Identificador del conjunto de datos con el que se va a exportar el informe. Solo es necesario si se exporta con un conjunto de datos distinto del predeterminado del informe.
defaultBookmark	PageBookmark	Marcador predeterminado que se va a aplicar en todas las páginas que no tienen un marcador específico
identities	EffectiveIdentity[]	Lista de identidades que se van a usar para las reglas de seguridad de nivel de fila
pages	ExportReportPage[]	Lista de páginas que se van a exportar y sus propiedades. La misma página puede aparecer más de una vez con objetos visuales diferentes.
reportLevelFilters	ExportFilter[]	Lista de filtros de nivel de informe que se van a aplicar. Actualmente, solo se admite un filtro.
settings	ExportReportSettings	La configuración que se va a aplicar para la exportación al trabajo de archivo