Admin - WorkspaceInfo PostWorkspaceInfo

  • Referência
Service:
Power BI REST APIs
API Version:
v1.0

Inicia uma chamada para receber metadados para a lista solicitada de workspaces.

Importante

Se você definir os datasetSchema parâmetros ou datasetExpressions como true, deverá habilitar totalmente a verificação de metadados para que os dados sejam retornados. Para obter mais informações, consulte Habilitar configurações de locatário para verificação de metadados.

Permissões

O usuário deve ter direitos de administrador (como Microsoft Administrador Global do 365 ou Administrador de Serviços do Power BI) ou autenticar usando uma entidade de serviço.

Ao executar em autenticação de entidade de serviço, um aplicativo não deve ter nenhuma permissão de consentimento de administrador necessária para o Power BI definida nele no portal do Azure.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Relevante somente ao autenticar por meio de um token de acesso de administrador delegado padrão. Não deve estar presente quando a autenticação por meio de uma entidade de serviço é usada.

Limitações

  • Máximo de 500 solicitações por hora.
  • Máximo de 16 solicitações 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 URI

Nome Em Obrigatório Tipo Description
datasetExpressions
 query

boolean

Se deve retornar expressões de conjunto de dados (consultas DAX e Mashup). Se você definir esse parâmetro como true, deverá habilitar totalmente a verificação de metadados para que os dados sejam retornados. Para obter mais informações, consulte Habilitar configurações de locatário para verificação de metadados.
datasetSchema
 query

boolean

Se o esquema do conjunto de dados deve ser retornado (tabelas, colunas e medidas). Se você definir esse parâmetro como true, deverá habilitar totalmente a verificação de metadados para que os dados sejam retornados. Para obter mais informações, consulte Habilitar configurações de locatário para verificação de metadados.
datasourceDetails
 query

boolean

Se deseja retornar detalhes da fonte de dados
getArtifactUsers
 query

boolean

Se deseja retornar detalhes do usuário para um item do Power BI (como um relatório ou um painel)
lineage
 query

boolean

Se as informações de linhagem devem ser retornadas (fluxos de dados upstream, blocos, IDs de fonte de dados)

Corpo da solicitação

Nome Tipo Description
workspaces

string[]

As IDs de workspace necessárias a serem verificadas (dá suporte a 1 a 100 IDs de workspace)

Respostas

Nome Tipo Description
202 Accepted

ScanRequest

Aceita

Exemplos

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"
}

Definições

Nome Description
PowerBIApiErrorResponseDetail

Informações detalhadas sobre uma resposta de erro do Power BI
RequiredWorkspaces

Uma solicitação de workspaces necessária
ScanRequest

Uma solicitação de verificação

PowerBIApiErrorResponseDetail

Informações detalhadas sobre uma resposta de erro do Power BI

Nome Tipo Description
code

string

O código de erro
message

string

A mensagem de erro
target

string

O destino do erro

RequiredWorkspaces

Uma solicitação de workspaces necessária

Nome Tipo Description
workspaces

string[]

As IDs de workspace necessárias a serem verificadas (dá suporte a 1 a 100 IDs de workspace)

ScanRequest

Uma solicitação de verificação

Nome Tipo Description
createdDateTime

string

A data e a hora da criação da verificação
error

PowerBIApiErrorResponseDetail

O erro de verificação (se houver)
id

string

A ID da verificação
status

string

O estado de verificação