Imports - Post Import
Crea contenido nuevo en Mi área de trabajo.
Consulte la Importación de archivos grandes script de PowerShell para obtener un ejemplo de uso de esta API.
Nota:
Contenido admitido:
- Archivos .pbix de Power BI
- Archivos JSON (.json)
- Archivos de Excel (.xlsx)
- Archivos del lenguaje de definición de informes (.rdl)
- Para importar un archivo, especifique el tipo de contenido multipart/form-data en los encabezados de solicitud y codifique el archivo como datos de formulario en el cuerpo de la solicitud.
- Para importar el archivo De informes paginados(.rdl), incluya la extensión de archivo .rdl en el nombre especificado por
datasetDisplayName
, comopaginatedReport.rdl
, como se describe en parámetros de URI. La extensión de archivo endatasetDisplayName
ayudará a distinguir la carga de informes paginados (archivo.rdl) de otras cargas.- También se recomienda usar el SDK de C# (Galería de NuGet | Microsoft.PowerBI.Api) para cargas de informes paginados(.rdl).
- Para importar un archivo de .xlsx desde OneDrive para la Empresa, incluya el tipo de contenido application/json en los encabezados de solicitud. Incluya ImportInfo con
filePath
establecido en la ruta de acceso del archivo .xlsx en el cuerpo de la solicitud. - Para importar archivos .pbix de Power BI de gran tamaño entre 1 GB y 10 GB, consulte Crear ubicación de carga temporal. Esto solo se admite para áreas de trabajo de capacidad Premium.
- Para crear un flujo de datos a partir de un archivo de model.json, establezca
datasetDisplayName
en model.json, como se describe en parámetros de URI.
Ámbito requerido
Dataset.ReadWrite.All
Limitaciones
- No se admiten flujos de datos con la entidad de servicio.
- No se admite la importación de un archivo .pbix de Power BI desde OneDrive.
- No se admite la importación de un archivo que tenga una etiqueta de confidencialidad protegida para las entidades de servicio.
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
dataset
|
query | True |
string |
El nombre para mostrar del conjunto de datos debe incluir la extensión de archivo. No se admite al importar desde OneDrive para la Empresa. |
name
|
query |
Especifica qué hacer si ya existe un conjunto de datos con el mismo nombre. El valor predeterminado es |
||
override
|
query |
boolean |
Si se invalida la etiqueta existente en un modelo al volver a publicar un archivo .pbix de Power BI. El valor predeterminado del servicio es |
|
override
|
query |
boolean |
Si se invalida la etiqueta de informe existente al volver a publicar un archivo .pbix de Power BI. El valor predeterminado del servicio es |
|
skip
|
query |
boolean |
Si se va a omitir la importación de informes. Si se especifica, el valor debe ser |
|
subfolder
|
query |
string (uuid) |
Identificador de subcarpeta para importar el archivo a la subcarpeta. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
connectionType |
Tipo de conexión de importación para un archivo de OneDrive para la Empresa |
|
filePath |
string |
Ruta de acceso del archivo de Excel de OneDrive para la Empresa (.xlsx) que se va a importar, que puede ser absoluto o relativo. No se admiten archivos .pbix de Power BI. |
fileUrl |
string |
Dirección URL de firma de acceso compartido del almacenamiento de blobs temporal que se usa para importar archivos .pbix de Power BI grandes entre 1 GB y 10 GB de tamaño. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
De acuerdo |
|
202 Accepted |
Aceptado |
Ejemplos
Import dataflow example |
Post import example |
Post import with 'skip |
Import dataflow example
Solicitud de ejemplo
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=model.json&nameConflict=Abort
{
"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--"
}
Respuesta de muestra
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Post import example
Solicitud de ejemplo
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Respuesta de muestra
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Post import with 'skipReport' example
Solicitud de ejemplo
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Respuesta de muestra
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
Definiciones
Nombre | Description |
---|---|
connection |
Tipo de conexión de importación para un archivo de OneDrive para la Empresa |
Dataset |
Un conjunto de datos de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades del conjunto de datos. El subconjunto depende de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI. |
Dataset |
Consulta de la configuración de escalabilidad horizontal de un conjunto de datos |
Dataset |
Una entrada adecuada de acceso de usuario de Power BI para un conjunto de datos |
Dataset |
Derecho de acceso que el usuario tiene para el conjunto de datos (nivel de permiso) |
Dependent |
Un flujo de datos dependiente de Power BI |
Encryption |
Información de cifrado de un conjunto de datos |
Encryption |
Estado de cifrado del conjunto de datos |
Import |
El objeto import |
Import |
Especifica qué hacer si ya existe un conjunto de datos con el mismo nombre. El valor predeterminado es |
Import |
La información sobre la importación |
Principal |
El tipo de entidad de seguridad |
Report |
Un informe de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades de informe. El subconjunto depende de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI. |
Report |
Una entrada adecuada de acceso de usuario de Power BI para un informe |
Report |
Derecho de acceso que el usuario tiene para el informe (nivel de permiso) |
Service |
Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded. |
Subscription |
Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel) |
Subscription |
Un usuario de suscripción de correo electrónico de Power BI |
connectionType
Tipo de conexión de importación para un archivo de OneDrive para la Empresa
Valor | Description |
---|---|
connect | |
import |
Dataset
Un conjunto de datos de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades del conjunto de datos. El subconjunto depende de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.
Nombre | Tipo | Description |
---|---|---|
ContentProviderType |
string |
Propiedad en desuso que se debe omitir. |
Encryption |
Información de cifrado del conjunto de datos. Solo es aplicable cuando se especifica |
|
IsEffectiveIdentityRequired |
boolean |
Si el conjunto de datos requiere una identidad eficaz, que debe enviar en una llamada API de GenerateToken. |
IsEffectiveIdentityRolesRequired |
boolean |
Si la seguridad de nivel de fila se define dentro del archivo .pbix de Power BI. Si es así, debe especificar un rol. |
IsInPlaceSharingEnabled |
boolean |
Si el conjunto de datos se puede compartir con usuarios externos que se van a consumir en su propio inquilino |
IsOnPremGatewayRequired |
boolean |
Si el conjunto de datos requiere una puerta de enlace de datos local |
IsRefreshable |
boolean |
Este campo devuelve |
addRowsAPIEnabled |
boolean |
Si el conjunto de datos permite agregar nuevas filas |
configuredBy |
string |
Propietario del conjunto de datos |
createReportEmbedURL |
string |
Dirección URL de inserción del informe de creación del conjunto de datos |
createdDate |
string (date-time) |
Fecha y hora de creación del conjunto de datos |
description |
string |
Descripción del conjunto de datos |
id |
string |
Identificador del conjunto de datos |
name |
string |
Nombre del conjunto de datos |
qnaEmbedURL |
string |
Dirección URL de inserción del conjunto de datos Q&A |
queryScaleOutSettings |
Consulta de la configuración de escalabilidad horizontal de un conjunto de datos |
|
targetStorageMode |
string |
Modo de almacenamiento del conjunto de datos |
upstreamDataflows |
La lista de todos los flujos de datos de este elemento depende de |
|
users |
(Valor vacío) Detalles de acceso del usuario del conjunto de datos. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un elemento de Power BI (por ejemplo, un informe o un panel) mediante el uso de Obtener usuarios del conjunto de datos como API de administrador o la API de PostWorkspaceInfo con el parámetro |
|
webUrl |
string |
Dirección URL web del conjunto de datos |
DatasetQueryScaleOutSettings
Consulta de la configuración de escalabilidad horizontal de un conjunto de datos
Nombre | Tipo | Description |
---|---|---|
autoSyncReadOnlyReplicas |
boolean |
Si el conjunto de datos sincroniza automáticamente las réplicas de solo lectura |
maxReadOnlyReplicas |
integer minimum: -1maximum: 64 |
Número máximo de réplicas de solo lectura para el conjunto de datos (de 0 a 64, -1 para el número automático de réplicas) |
DatasetUser
Una entrada adecuada de acceso de usuario de Power BI para un conjunto de datos
Nombre | Tipo | Description |
---|---|---|
datasetUserAccessRight |
Derecho de acceso que el usuario tiene para el conjunto de datos (nivel de permiso) |
|
displayName |
string |
Nombre para mostrar de la entidad de seguridad |
emailAddress |
string |
Dirección de correo electrónico del usuario |
graphId |
string |
Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administración. |
identifier |
string |
Identificador de la entidad de seguridad |
principalType |
El tipo de entidad de seguridad |
|
profile |
Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded. |
|
userType |
string |
Tipo del usuario. |
DatasetUserAccessRight
Derecho de acceso que el usuario tiene para el conjunto de datos (nivel de permiso)
Valor | Description |
---|---|
None |
Quita el permiso para el contenido del conjunto de datos. |
Read |
Concede acceso de lectura al contenido del conjunto de datos. |
ReadExplore |
Concede acceso de lectura y exploración al contenido del conjunto de datos |
ReadReshare |
Concede acceso de lectura y volver a compartir el contenido del conjunto de datos |
ReadReshareExplore |
Concede acceso de lectura, volver a compartir y explorar el acceso al contenido del conjunto de datos |
ReadWrite |
Concede acceso de lectura y escritura al contenido del conjunto de datos |
ReadWriteExplore |
Concede acceso de lectura, escritura y exploración al contenido del conjunto de datos |
ReadWriteReshare |
Concede acceso de lectura, escritura y volver a compartir el contenido del conjunto de datos |
ReadWriteReshareExplore |
Concede acceso de lectura, escritura, volver a compartir y explorar el acceso al contenido del conjunto de datos |
DependentDataflow
Un flujo de datos dependiente de Power BI
Nombre | Tipo | Description |
---|---|---|
groupId |
string |
Identificador del grupo de destino |
targetDataflowId |
string |
Identificador del flujo de datos de destino |
Encryption
Información de cifrado de un conjunto de datos
Nombre | Tipo | Description |
---|---|---|
EncryptionStatus |
Estado de cifrado del conjunto de datos |
EncryptionStatus
Estado de cifrado del conjunto de datos
Valor | Description |
---|---|
InSyncWithWorkspace |
Se admite el cifrado y está sincronizado con la configuración de cifrado. |
NotInSyncWithWorkspace |
Se admite el cifrado, pero no está sincronizado con la configuración de cifrado. |
NotSupported |
El cifrado no se admite para este conjunto de datos |
Unknown |
El estado de cifrado es desconocido debido a daños en el conjunto de datos. |
Import
El objeto import
Nombre | Tipo | Description |
---|---|---|
createdDateTime |
string (date-time) |
Importar fecha y hora de creación |
datasets |
Dataset[] |
Conjuntos de datos asociados a esta importación |
id |
string (uuid) |
Identificador de importación |
importState |
enum:
|
Estado de carga de importación |
name |
string |
Nombre de importación |
reports |
Report[] |
Los informes asociados a esta importación |
updatedDateTime |
string (date-time) |
Importar la fecha y hora de la última actualización |
ImportConflictHandlerMode
Especifica qué hacer si ya existe un conjunto de datos con el mismo nombre. El valor predeterminado es Ignore
. Para los archivos RDL, Abort
y Overwrite
son las únicas opciones admitidas y no otras.
Valor | Description |
---|---|
Abort |
Si ya existe un conjunto de datos con el mismo nombre, se cancelará la operación de importación. |
CreateOrOverwrite |
Si ya existe un conjunto de datos con el mismo nombre, la operación de importación reemplazará el conjunto de datos existente por el nuevo. Se producirá un error en la operación de importación si hay más de un conjunto de datos existente con el mismo nombre. |
GenerateUniqueName |
Si ya existe un flujo de datos con el mismo nombre, la operación de importación generará un nuevo nombre único para el nuevo flujo de datos. |
Ignore |
Si ya existe un conjunto de datos con el mismo nombre, la operación de importación creará un nuevo conjunto de datos con el mismo nombre. |
Overwrite |
Si ya existe un conjunto de datos con el mismo nombre, la operación de importación reemplazará el conjunto de datos existente por el nuevo. Se producirá un error en la operación de importación si no hay ningún conflicto o si hay más de un conjunto de datos existente con el mismo nombre. |
ImportInfo
La información sobre la importación
Nombre | Tipo | Description |
---|---|---|
connectionType |
Tipo de conexión de importación para un archivo de OneDrive para la Empresa |
|
filePath |
string |
Ruta de acceso del archivo de Excel de OneDrive para la Empresa (.xlsx) que se va a importar, que puede ser absoluto o relativo. No se admiten archivos .pbix de Power BI. |
fileUrl |
string |
Dirección URL de firma de acceso compartido del almacenamiento de blobs temporal que se usa para importar archivos .pbix de Power BI grandes entre 1 GB y 10 GB de tamaño. |
PrincipalType
El tipo de entidad de seguridad
Valor | Description |
---|---|
App |
Tipo de entidad de servicio |
Group |
Tipo de entidad de seguridad de grupo |
None |
No hay ningún tipo de entidad de seguridad. Se usa para el acceso de nivel de organización completo. |
User |
Tipo de entidad de seguridad de usuario |
Report
Un informe de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades de informe. El subconjunto depende de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.
Nombre | Tipo | Description |
---|---|---|
appId |
string |
El identificador de la aplicación, devuelto solo si el informe pertenece a una aplicación |
datasetId |
string |
Identificador del conjunto de datos del informe |
description |
string |
Descripción del informe |
embedUrl |
string |
Dirección URL de inserción del informe |
id |
string (uuid) |
Identificador del informe |
isOwnedByMe |
boolean |
Indica si el usuario actual tiene la capacidad de modificar o crear una copia del informe. |
name |
string |
Nombre del informe. Los informes de la aplicación comienzan con el prefijo [App]. |
originalReportId |
string (uuid) |
Identificador de informe real cuando el área de trabajo se publica como una aplicación. |
reportType |
enum:
|
El tipo de informe |
subscriptions |
(Valor vacío) Los detalles de la suscripción de un elemento de Power BI (por ejemplo, un informe o un panel). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar la información de suscripción de un informe de Power BI mediante el Obtener suscripciones de informe como llamada API de administrador. |
|
users |
(Valor vacío) Detalles de acceso de usuario para un informe de Power BI. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un informe de Power BI mediante la llamada API de Obtener informes como administrador API o la llamada API de PostWorkspaceInfo con el parámetro |
|
webUrl |
string |
Dirección URL web del informe |
ReportUser
Una entrada adecuada de acceso de usuario de Power BI para un informe
Nombre | Tipo | Description |
---|---|---|
displayName |
string |
Nombre para mostrar de la entidad de seguridad |
emailAddress |
string |
Dirección de correo electrónico del usuario |
graphId |
string |
Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administración. |
identifier |
string |
Identificador de la entidad de seguridad |
principalType |
El tipo de entidad de seguridad |
|
profile |
Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded. |
|
reportUserAccessRight |
Derecho de acceso que el usuario tiene para el informe (nivel de permiso) |
|
userType |
string |
Tipo del usuario. |
ReportUserAccessRight
Derecho de acceso que el usuario tiene para el informe (nivel de permiso)
Valor | Description |
---|---|
None |
Sin permiso para el contenido del informe |
Owner |
Concede acceso de lectura, escritura y recompartición al contenido del informe |
Read |
Concede acceso de lectura al contenido del informe |
ReadCopy |
Concede acceso de lectura y copia al contenido del informe |
ReadReshare |
Concede acceso de lectura y volver a compartir el contenido del informe |
ReadWrite |
Concede acceso de lectura y escritura al contenido del informe |
ServicePrincipalProfile
Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
Nombre | Tipo | Description |
---|---|---|
displayName |
string |
El nombre del perfil de entidad de servicio |
id |
string (uuid) |
Identificador del perfil de la entidad de servicio |
Subscription
Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)
Nombre | Tipo | Description |
---|---|---|
artifactDisplayName |
string |
Nombre del elemento de Power BI suscrito (por ejemplo, un informe o un panel) |
artifactId |
string (uuid) |
Identificador del elemento de Power BI suscrito (por ejemplo, un informe o un panel) |
artifactType |
string |
Tipo de elemento de Power BI (por ejemplo, un |
attachmentFormat |
string |
Formato del informe adjunto en la suscripción de correo electrónico |
endDate |
string (date-time) |
Fecha y hora de finalización de la suscripción de correo electrónico |
frequency |
string |
Frecuencia de la suscripción de correo electrónico |
id |
string (uuid) |
Identificador de suscripción |
isEnabled |
boolean |
Si la suscripción de correo electrónico está habilitada |
linkToContent |
boolean |
Si existe un vínculo de suscripción en la suscripción de correo electrónico |
previewImage |
boolean |
Si existe una captura de pantalla del informe en la suscripción de correo electrónico |
startDate |
string (date-time) |
La fecha y hora de inicio de la suscripción de correo electrónico |
subArtifactDisplayName |
string |
Nombre de página del elemento de Power BI suscrito, si es un informe. |
title |
string |
El nombre de la aplicación |
users |
Los detalles de cada suscriptor de correo electrónico. Cuando se usa la llamada API de Obtener suscripciones de usuario como administrador, el valor devuelto es una matriz vacía (null). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción en un informe o panel de Power BI mediante las llamadas api de Obtener suscripciones de informe como administrador o Obtener suscripciones de panel como administrador API. |
SubscriptionUser
Un usuario de suscripción de correo electrónico de Power BI
Nombre | Tipo | Description |
---|---|---|
displayName |
string |
Nombre para mostrar de la entidad de seguridad |
emailAddress |
string |
Dirección de correo electrónico del usuario |
graphId |
string |
Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administración. |
identifier |
string |
Identificador de la entidad de seguridad |
principalType |
El tipo de entidad de seguridad |
|
profile |
Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded. |
|
userType |
string |
Tipo del usuario. |