Imports - Get Import

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Devuelve la importación especificada desde Mi área de trabajo.

Ámbito requerido

Dataset.ReadWrite.All o Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/imports/{importId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
importId	path	True	string uuid	Identificador de importación

Respuestas

Nombre	Tipo	Description
200 OK	Import	Aceptar

Ejemplos

Completed import example

In-progress import example

Completed import example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7

Sample Response

Status code:: 200

{
  "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
  "importState": "Succeeded",
  "createdDateTime": "2018-05-08T14:56:18.477Z",
  "updatedDateTime": "2018-05-08T14:56:18.477Z",
  "name": "SalesMarketing",
  "connectionType": "import",
  "source": "Upload",
  "datasets": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ],
  "reports": [
    {
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

In-progress import example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7

Sample Response

Status code:: 200

{
  "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
  "importState": "Publishing",
  "createdDateTime": "2018-05-08T14:56:18.477Z",
  "updatedDateTime": "2018-05-08T14:56:18.477Z",
  "name": "SalesMarketing",
  "connectionType": "import",
  "source": "Upload",
  "datasets": [],
  "reports": []
}

Definiciones

Nombre	Description
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 llamada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.
DatasetQueryScaleOutSettings	Consulta de la configuración de escalabilidad horizontal de un conjunto de datos
DatasetUser	Una entrada correcta de acceso de usuario de Power BI para un conjunto de datos
DatasetUserAccessRight	Derecho de acceso que el usuario tiene para el conjunto de datos (nivel de permiso)
DependentDataflow	Un flujo de datos dependiente de Power BI
Encryption	Información de cifrado de un conjunto de datos
EncryptionStatus	Estado de cifrado del conjunto de datos
Import	El objeto import
PrincipalType	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 llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.
ReportUser	Entrada correcta de acceso de usuario de Power BI para un informe
ReportUserAccessRight	Derecho de acceso que el usuario tiene para el informe (nivel de permiso)
ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
Subscription	Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)
SubscriptionUser	Un usuario de suscripción de correo electrónico de Power BI

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 llamada, 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	Tipo de proveedor de contenido para el conjunto de datos
CreateReportEmbedURL	string	Dirección URL de inserción del informe de creación del conjunto de datos
CreatedDate	string	Fecha y hora de creación del conjunto de datos
Encryption	Encryption	Información de cifrado del conjunto de datos. Solo se aplica cuando `$expand` se especifica .
IsEffectiveIdentityRequired	boolean	Si el conjunto de datos requiere una identidad eficaz, que debe enviar en una llamada a la API 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	Si el conjunto de datos es actualizable o no. Un conjunto de datos actualizable de Power BI es un conjunto de datos que se ha actualizado al menos una vez o para el que existe una programación de actualización válida.
QnaEmbedURL	string	Dirección URL de inserción de Q&del conjunto de datos
addRowsAPIEnabled	boolean	Si el conjunto de datos permite agregar nuevas filas
configuredBy	string	Propietario 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
queryScaleOutSettings	DatasetQueryScaleOutSettings	Consulta de la configuración de escalabilidad horizontal de un conjunto de datos
targetStorageMode	string	Modo de almacenamiento del conjunto de datos
upstreamDataflows	DependentDataflow[]	La lista de todos los flujos de datos de este elemento depende de
users	DatasetUser[]	(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 la API Obtener usuarios del conjunto de datos como Administración API o postWorkspaceInfo API con el `getArtifactUsers` 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	Número máximo de réplicas de solo lectura para el conjunto de datos (0-64, -1 para el número automático de réplicas)

DatasetUser

Una entrada correcta de acceso de usuario de Power BI para un conjunto de datos

Nombre	Tipo	Description
datasetUserAccessRight	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 administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
userType	string	Tipo del usuario.

DatasetUserAccessRight

Derecho de acceso que el usuario tiene para el conjunto de datos (nivel de permiso)

Nombre	Tipo	Description
None	string	Quita el permiso para el contenido del conjunto de datos.
Read	string	Concede acceso de lectura al contenido del conjunto de datos.
ReadExplore	string	Concede acceso de lectura y exploración al contenido del conjunto de datos.
ReadReshare	string	Concede acceso de lectura y recompartición al contenido del conjunto de datos
ReadReshareExplore	string	Concede acceso de lectura, volver a compartir y explorar el contenido del conjunto de datos.
ReadWrite	string	Concede acceso de lectura y escritura al contenido del conjunto de datos.
ReadWriteExplore	string	Concede acceso de lectura, escritura y exploración al contenido del conjunto de datos.
ReadWriteReshare	string	Concede acceso de lectura, escritura y volver a compartir el contenido del conjunto de datos.
ReadWriteReshareExplore	string	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	EncryptionStatus	Estado de cifrado del conjunto de datos

EncryptionStatus

Estado de cifrado del conjunto de datos

Nombre	Tipo	Description
InSyncWithWorkspace	string	Se admite el cifrado y está sincronizado con la configuración de cifrado.
NotInSyncWithWorkspace	string	Se admite el cifrado, pero no está sincronizado con la configuración de cifrado.
NotSupported	string	El cifrado no se admite para este conjunto de datos
Unknown	string	El estado de cifrado es desconocido debido a daños en el conjunto de datos.

Import

El objeto import

Nombre	Tipo	Description
createdDateTime	string	Importar fecha y hora de creación
datasets	Dataset[]	Conjuntos de datos asociados a esta importación
id	string	Identificador de importación
importState	enum: Failed Publishing Succeeded	Estado de carga de importación
name	string	Nombre de importación
reports	Report[]	Los informes asociados a esta importación
updatedDateTime	string	Importar la fecha y hora de la última actualización

PrincipalType

El tipo de entidad de seguridad

Nombre	Tipo	Description
App	string	Tipo de entidad de servicio
Group	string	Tipo de entidad de seguridad de grupo
None	string	No hay ningún tipo de entidad de seguridad. Se usa para el acceso de nivel de organización completo.
User	string	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 llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.

Nombre	Tipo	Description
appId	string	El identificador de la aplicación, que se devuelve solo si el informe pertenece a una aplicación
datasetId	string	El 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	Identificador del informe
isOwnedByMe	boolean	Determine si el usuario actual crea el informe.
name	string	Nombre del informe
originalReportId	string	Identificador de informe real cuando el área de trabajo se publica como una aplicación.
reportType	enum: PaginatedReport PowerBIReport	Tipo de informe
subscriptions	Subscription[]	(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 información de suscripción para un informe de Power BI mediante la llamada a la API Obtener suscripciones de informes como Administración.
users	ReportUser[]	(Valor vacío) Detalles de acceso del 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 a la API Obtener usuarios de informes como Administración o la llamada API de PostWorkspaceInfo con el `getArtifactUsers` parámetro .
webUrl	string	Dirección URL web del informe

ReportUser

Entrada correcta 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 administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
reportUserAccessRight	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)

Nombre	Tipo	Description
None	string	No hay permiso para el contenido del informe
Owner	string	Concede acceso de lectura, escritura y recompartición al contenido del informe
Read	string	Concede acceso de lectura al contenido del informe
ReadCopy	string	Concede acceso de lectura y copia al contenido del informe
ReadReshare	string	Concede acceso de lectura y volver a compartir el contenido del informe
ReadWrite	string	Concede acceso de lectura y escritura al contenido del informe

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

Nombre	Tipo	Description
displayName	string	Nombre del perfil de entidad de servicio
id	string	Identificador del perfil de 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	Identificador del elemento de Power BI suscrito (por ejemplo, un informe o un panel)
artifactType	string	Tipo de elemento de Power BI (por ejemplo, `Dashboard`, `Report`o `Dataset`).
attachmentFormat	string	Formato del informe adjunto en la suscripción de correo electrónico
endDate	string	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	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	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	SubscriptionUser[]	Los detalles de cada suscriptor de correo electrónico. Al usar la llamada API Get User Subscriptions As Administración, 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 obtener suscripciones de informe como Administración o Obtener suscripciones de panel como Administración llamadas 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 administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
userType	string	Tipo del usuario.

Compartir a través de

Imports - Get Import

Ámbito requerido

Parámetros de identificador URI

Respuestas

Ejemplos

Completed import example

Sample Request

Sample Response

In-progress import example

Sample Request

Sample Response

Definiciones

Dataset

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

Import

PrincipalType

Report

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Recursos adicionales