Admin - WorkspaceInfo PostWorkspaceInfo

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Inicia una llamada para recibir metadatos para la lista solicitada de áreas de trabajo.

Importante

Si establece los parámetros o datasetExpressions en , debe habilitar completamente el datasetSchema examen de metadatos truepara que se devuelvan los datos. Para obtener más información, consulte Habilitación de la configuración del inquilino para el examen de metadatos.

Permisos

El usuario debe tener derechos de administrador (como Microsoft administrador global de 365 o administrador del servicio Power BI) o autenticarse mediante una entidad de servicio.

Cuando se ejecuta en la autenticación de la entidad de servicio, una aplicación no debe tener ningún permiso necesario de consentimiento del administrador para Power BI establecido en él en el Azure Portal.

Ámbito requerido

Tenant.Read.All o Tenant.ReadWrite.All

Solo es relevante al autenticarse a través de un token de acceso de administrador delegado estándar. No debe estar presente cuando se usa la autenticación a través de una entidad de servicio.

Limitaciones

Máximo de 500 solicitudes por hora.
Máximo de 16 solicitudes simultáneas.

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}

Parámetros de identificador URI

Nombre	En	Tipo	Description
datasetExpressions	query	boolean	Si se devuelven expresiones de conjunto de datos (consultas DAX y Mashup). Si establece este parámetro `true`en , debe habilitar completamente el examen de metadatos para que se devuelvan los datos. Para obtener más información, consulte Habilitación de la configuración del inquilino para el examen de metadatos.
datasetSchema	query	boolean	Si se va a devolver el esquema del conjunto de datos (tablas, columnas y medidas). Si establece este parámetro `true`en , debe habilitar completamente el examen de metadatos para que se devuelvan los datos. Para obtener más información, consulte Habilitación de la configuración del inquilino para el examen de metadatos.
datasourceDetails	query	boolean	Si se devuelven los detalles del origen de datos
getArtifactUsers	query	boolean	Si se devuelven los detalles del usuario de un elemento de Power BI (por ejemplo, un informe o un panel)
lineage	query	boolean	Si se va a devolver información de linaje (flujos de datos ascendentes, iconos, identificadores de origen de datos)

Cuerpo de la solicitud

Nombre	Tipo	Description
workspaces	string[]	Identificadores de área de trabajo necesarios que se van a examinar (admite de 1 a 100 identificadores de área de trabajo).

Respuestas

Nombre	Tipo	Description
202 Accepted	ScanRequest	Accepted

Ejemplos

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True

Request Body

{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Sample Response

Status code:: 202

{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

Definiciones

Nombre	Description
PowerBIApiErrorResponseDetail	Información detallada sobre una respuesta de error de Power BI
RequiredWorkspaces	Solicitud de áreas de trabajo necesarias
ScanRequest	Una solicitud de examen

PowerBIApiErrorResponseDetail

Información detallada sobre una respuesta de error de Power BI

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error

RequiredWorkspaces

Solicitud de áreas de trabajo necesarias

Nombre	Tipo	Description
workspaces	string[]	Identificadores de área de trabajo necesarios que se van a examinar (admite de 1 a 100 identificadores de área de trabajo).

ScanRequest

Una solicitud de examen

Nombre	Tipo	Description
createdDateTime	string	Fecha y hora de creación del examen
error	PowerBIApiErrorResponseDetail	Error de examen (si existe)
id	string	El identificador de examen
status	string	El estado del examen