Imports - Post Import In Group

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

Cria um novo conteúdo no workspace especificado.

Observação

Conteúdo com suporte:

  • Arquivos .pbix do Power BI
  • Arquivos JSON (.json)
  • Arquivos do Excel (.xlsx)
  • SQL Server arquivos de linguagem de definição de relatório (.rdl)
  • Para importar um arquivo, especifique o tipo de conteúdo multipart/form-data nos cabeçalhos de solicitação e codifique o arquivo como dados de formulário no corpo da solicitação.
  • Para importar um arquivo .rdl, inclua a extensão de arquivo no nome especificado por datasetDisplayName, conforme descrito em parâmetros de URI.
  • Para importar um arquivo .xlsx de OneDrive for Business, inclua o tipo de conteúdo application/json nos cabeçalhos de solicitação. Inclua ImportInfo com filePath definido como o caminho do arquivo .xlsx no corpo da solicitação.
  • Para importar arquivos .pbix grandes do Power BI que têm entre 1 GB e 10 GB de tamanho, consulte Criar local de carregamento temporário em grupo e o script importar arquivos grandes do PowerShell. Isso só tem suporte para workspaces de capacidade Premium.
  • Para criar um fluxo de dados de um arquivo de model.json, defina datasetDisplayName como model.json, conforme descrito em Parâmetros de URI.

Permissões

Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Dataset.ReadWrite.All

Limitações

  • Não há suporte para fluxos de dados com entidade de serviço.
  • Não há suporte para a importação de um arquivo .pbix do Power BI do OneDrive.
  • Não há suporte para a importação de um arquivo que tenha um rótulo de confidencialidade protegido para entidades de serviço. 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
groupId
 path True

string

uuid

A ID do workspace
datasetDisplayName
 query True

string

O nome de exibição do conjunto de dados deve incluir a extensão de arquivo. Não há suporte para a importação de OneDrive for Business. Para importar ou criar fluxos de dados, esse parâmetro deve ser codificado para model.json.
nameConflict
 query

ImportConflictHandlerMode

Especifica o que fazer se um conjunto de dados com o mesmo nome já existir. O valor padrão é Ignore. Para arquivos RDL, Abort e Overwrite são as únicas opções com suporte. Para o fluxo de dados model.json arquivos Abort e GenerateUniqueName são as únicas opções com suporte.
overrideModelLabel
 query

boolean

Determina se o rótulo existente deve ser substituído em um modelo ao republicar um arquivo .pbix do Power BI. O valor padrão do serviço é true.
overrideReportLabel
 query

boolean

Se deseja substituir o rótulo existente em um relatório ao republicar um arquivo .pbix do Power BI. O valor padrão do serviço é true.
skipReport
 query

boolean

Se deseja ignorar a importação de relatório. Se especificado, o valor deverá ser true. Há suporte apenas para arquivos .pbix do Power BI.

Corpo da solicitação

Media Types: "application/json", "multipart/form-data"

Nome Tipo Description
connectionType

connectionType

O tipo de conexão de importação para um arquivo de OneDrive for Business
filePath

string

O caminho do arquivo do OneDrive for Business Excel (.xlsx) a ser importado, que pode ser absoluto ou relativo. Não há suporte para arquivos .pbix do Power BI.
fileUrl

string

A URL de assinatura de acesso compartilhado do armazenamento de blobs temporário usado para importar arquivos .pbix grandes do Power BI entre 1 GB e 10 GB de tamanho.

Respostas

Nome Tipo Description
200 OK

Import

OK
202 Accepted

Import

Aceito

Exemplos

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Request Body
{
  "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--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Definições

Nome Description
connectionType

O tipo de conexão de importação para um arquivo de OneDrive for Business
Dataset

Um conjunto de dados do Power BI. A API retorna um subconjunto da lista de propriedades do conjunto de dados a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.
DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados
DatasetUser

Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados
DatasetUserAccessRight

O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
DependentDataflow

Um fluxo de dados dependente do Power BI
Encryption

Informações de criptografia para um conjunto de dados
EncryptionStatus

Status de criptografia de conjunto de dados
Import

O objeto de importação
ImportConflictHandlerMode

Especifica o que fazer se um conjunto de dados com o mesmo nome já existir. O valor padrão é Ignore. Para arquivos RDL, Abort e Overwrite são as únicas opções com suporte. Para o fluxo de dados model.json arquivos Abort e GenerateUniqueName são as únicas opções com suporte.
ImportInfo

As informações sobre a importação
PrincipalType

O tipo de entidade de segurança
Report

Um relatório do Power BI. A API retorna um subconjunto da lista de propriedades de relatório a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
ReportUser

Uma entrada correta de acesso de usuário do Power BI para um relatório
ReportUserAccessRight

O direito de acesso que o usuário tem para o relatório (nível de permissão)
ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
Subscription

Uma assinatura de email para um item do Power BI (como um relatório ou um dashboard)
SubscriptionUser

Um usuário de assinatura de email do Power BI

connectionType

O tipo de conexão de importação para um arquivo de OneDrive for Business

Nome Tipo Description
connect

string

import

string

Dataset

Um conjunto de dados do Power BI. A API retorna um subconjunto da lista de propriedades do conjunto de dados a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.

Nome Tipo Description
ContentProviderType

string

O tipo de provedor de conteúdo para o conjunto de dados
CreateReportEmbedURL

string

O conjunto de dados criar URL de inserção de relatório
CreatedDate

string

A data e a hora de criação do conjunto de dados
Encryption

Encryption

Informações de criptografia do conjunto de dados. Aplicável somente quando $expand for especificado.
IsEffectiveIdentityRequired

boolean

Se o conjunto de dados requer uma identidade efetiva, que você deve enviar em uma chamada à API GenerateToken .
IsEffectiveIdentityRolesRequired

boolean

Se a segurança em nível de linha é definida dentro do arquivo .pbix do Power BI. Nesse caso, você deve especificar uma função.
IsInPlaceSharingEnabled

boolean

Se o conjunto de dados pode ser compartilhado com usuários externos a serem consumidos em seu próprio locatário
IsOnPremGatewayRequired

boolean

Se o conjunto de dados requer um gateway de dados local
IsRefreshable

boolean

Se o conjunto de dados é atualizável ou não. Um conjunto de dados atualizável do Power BI é um conjunto de dados que foi atualizado pelo menos uma vez ou para o qual existe uma agenda de atualização válida.
QnaEmbedURL

string

A URL de inserção do conjunto de dados Q&A
addRowsAPIEnabled

boolean

Se o conjunto de dados permite adicionar novas linhas
configuredBy

string

O proprietário do conjunto de dados
description

string

A descrição do conjunto de dados
id

string

A ID do conjunto de dados
name

string

O nome do conjunto de dados
queryScaleOutSettings

DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados
targetStorageMode

string

O modo de armazenamento do conjunto de dados
upstreamDataflows

DependentDataflow[]

A lista de todos os fluxos de dados dos quais este item depende
users

DatasetUser[]

(Valor vazio) Os detalhes de acesso do usuário do conjunto de dados. Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações do usuário em um item do Power BI (como um relatório ou um dashboard) usando a API Obter Usuários do Conjunto de Dados como Administração ou a API PostWorkspaceInfo com o getArtifactUsers parâmetro .
webUrl

string

A URL da Web do conjunto de dados

DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados

Nome Tipo Description
autoSyncReadOnlyReplicas

boolean

Se o conjunto de dados sincroniza automaticamente réplicas somente leitura
maxReadOnlyReplicas

integer

Número máximo de réplicas somente leitura para o conjunto de dados (0-64, -1 para o número automático de réplicas)

DatasetUser

Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados

Nome Tipo Description
datasetUserAccessRight

DatasetUserAccessRight

O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
displayName

string

Nome de exibição da entidade de segurança
emailAddress

string

Endereço de email do usuário
graphId

string

Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo de entidade de segurança
profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
userType

string

Tipo do usuário.

DatasetUserAccessRight

O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)

Nome Tipo Description
None

string

Remove a permissão para o conteúdo no conjunto de dados
Read

string

Concede acesso de leitura ao conteúdo no conjunto de dados
ReadExplore

string

Concede acesso de Leitura e Exploração ao conteúdo no conjunto de dados
ReadReshare

string

Concede acesso de leitura e recompartilhamento ao conteúdo no conjunto de dados
ReadReshareExplore

string

Concede acesso de Leitura, Recompartilhar e Explorar ao conteúdo no conjunto de dados
ReadWrite

string

Concede acesso de leitura e gravação ao conteúdo no conjunto de dados
ReadWriteExplore

string

Concede acesso de Leitura, Gravação e Exploração ao conteúdo no conjunto de dados
ReadWriteReshare

string

Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no conjunto de dados
ReadWriteReshareExplore

string

Concede acesso de Leitura, Gravação, Recompartilhamento e Exploração ao conteúdo no conjunto de dados

DependentDataflow

Um fluxo de dados dependente do Power BI

Nome Tipo Description
groupId

string

A ID do grupo de destino
targetDataflowId

string

A ID do fluxo de dados de destino

Encryption

Informações de criptografia para um conjunto de dados

Nome Tipo Description
EncryptionStatus

EncryptionStatus

Status de criptografia de conjunto de dados

EncryptionStatus

Status de criptografia de conjunto de dados

Nome Tipo Description
InSyncWithWorkspace

string

A criptografia tem suporte e está sincronizada com as configurações de criptografia
NotInSyncWithWorkspace

string

A criptografia tem suporte, mas não está sincronizada com as configurações de criptografia
NotSupported

string

Não há suporte para criptografia para este conjunto de dados
Unknown

string

A status de criptografia é desconhecida devido à corrupção do conjunto de dados

Import

O objeto de importação

Nome Tipo Description
createdDateTime

string

Importar data e hora de criação
datasets

Dataset[]

Os conjuntos de dados associados a essa importação
id

string

A ID de importação
importState enum:
  • Failed
  • Publishing
  • Succeeded

O estado de carregamento de importação
name

string

O nome da importação
reports

Report[]

Os relatórios associados a essa importação
updatedDateTime

string

Importar data e hora da última atualização

ImportConflictHandlerMode

Especifica o que fazer se um conjunto de dados com o mesmo nome já existir. O valor padrão é Ignore. Para arquivos RDL, Abort e Overwrite são as únicas opções com suporte. Para o fluxo de dados model.json arquivos Abort e GenerateUniqueName são as únicas opções com suporte.

Nome Tipo Description
Abort

string

Se o conjunto de dados ou o fluxo de dados com o mesmo nome já existirem, a operação de importação será cancelada.
CreateOrOverwrite

string

Se já existir um conjunto de dados com o mesmo nome, a operação de importação substituirá o conjunto de dados existente pelo novo. A operação de importação falhará se houver mais de um conjunto de dados existente com o mesmo nome.
GenerateUniqueName

string

Se já existir um fluxo de dados com o mesmo nome, a operação de importação gerará um novo nome exclusivo para o novo fluxo de dados.
Ignore

string

Se já existir um conjunto de dados com o mesmo nome, a operação de importação criará um novo conjunto de dados com o mesmo nome.
Overwrite

string

Se já existir um conjunto de dados com o mesmo nome, a operação de importação substituirá o conjunto de dados existente pelo novo. A operação de importação falhará se não houver conflito ou se houver mais de um conjunto de dados existente com o mesmo nome.

ImportInfo

As informações sobre a importação

Nome Tipo Description
connectionType

connectionType

O tipo de conexão de importação para um arquivo de OneDrive for Business
filePath

string

O caminho do arquivo do OneDrive for Business Excel (.xlsx) a ser importado, que pode ser absoluto ou relativo. Não há suporte para arquivos .pbix do Power BI.
fileUrl

string

A URL de assinatura de acesso compartilhado do armazenamento de blobs temporário usado para importar arquivos .pbix grandes do Power BI entre 1 GB e 10 GB de tamanho.

PrincipalType

O tipo de entidade de segurança

Nome Tipo Description
App

string

Tipo de entidade de serviço
Group

string

Tipo de entidade de grupo
None

string

Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.
User

string

Tipo de entidade de usuário

Report

Um relatório do Power BI. A API retorna um subconjunto da lista de propriedades de relatório a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.

Nome Tipo Description
appId

string

A ID do aplicativo, retornada somente se o relatório pertencer a um aplicativo
datasetId

string

A ID do conjunto de dados do relatório
description

string

A descrição do relatório
embedUrl

string

A URL de inserção do relatório
id

string

A ID do relatório
name

string

O nome do relatório
originalReportId

string

A ID de relatório real quando o workspace é publicado como um aplicativo.
reportType enum:
  • PaginatedReport
  • PowerBIReport

O tipo de relatório
subscriptions

Subscription[]

(Valor vazio) Os detalhes da assinatura de um item do Power BI (como um relatório ou um dashboard). Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações de assinatura para um relatório do Power BI usando a chamada obter assinaturas de relatório como Administração API.
users

ReportUser[]

(Valor vazio) Os detalhes de acesso do usuário para um relatório do Power BI. Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando a chamada à API Obter Usuários de Relatório como Administração ou a chamada à API PostWorkspaceInfo com o getArtifactUsers parâmetro .
webUrl

string

A URL da Web do relatório

ReportUser

Uma entrada correta de acesso de usuário do Power BI para um relatório

Nome Tipo Description
displayName

string

Nome de exibição da entidade de segurança
emailAddress

string

Endereço de email do usuário
graphId

string

Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo de entidade de segurança
profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
reportUserAccessRight

ReportUserAccessRight

O direito de acesso que o usuário tem para o relatório (nível de permissão)
userType

string

Tipo do usuário.

ReportUserAccessRight

O direito de acesso que o usuário tem para o relatório (nível de permissão)

Nome Tipo Description
None

string

Nenhuma permissão para conteúdo no relatório
Owner

string

Concede acesso de leitura, gravação e compartilhamento ao conteúdo no relatório
Read

string

Concede acesso de leitura ao conteúdo no relatório
ReadCopy

string

Concede acesso de leitura e cópia ao conteúdo no relatório
ReadReshare

string

Concede acesso de leitura e recompartilhamento ao conteúdo no relatório
ReadWrite

string

Concede acesso de leitura e gravação ao conteúdo no relatório

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço
id

string

A ID do perfil da entidade de serviço

Subscription

Uma assinatura de email para um item do Power BI (como um relatório ou um dashboard)

Nome Tipo Description
artifactDisplayName

string

O nome do item do Power BI assinado (como um relatório ou um dashboard)
artifactId

string

A ID do item do Power BI assinado (como um relatório ou um dashboard)
artifactType

string

O tipo de item do Power BI (por exemplo, um Report, Dashboardou Dataset)
attachmentFormat

string

Formato do relatório anexado na assinatura de email
endDate

string

A data e a hora de término da assinatura de email
frequency

string

A frequência da assinatura de email
id

string

A ID da assinatura
isEnabled

boolean

Se a assinatura de email está habilitada
linkToContent

boolean

Se existe um link de assinatura na assinatura de email
previewImage

boolean

Se existe uma captura de tela do relatório na assinatura de email
startDate

string

A data e a hora de início da assinatura de email
subArtifactDisplayName

string

O nome da página do item do Power BI assinado, se for um relatório.
title

string

O nome do aplicativo
users

SubscriptionUser[]

Os detalhes de cada assinante de email. Ao usar a chamada à API Obter Assinaturas de Usuário Como Administração, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações de assinatura em um relatório do Power BI ou dashboard usando obter assinaturas de relatório como Administração ou obter assinaturas de painel como chamadas à API Administração.

SubscriptionUser

Um usuário de assinatura de email do Power BI

Nome Tipo Description
displayName

string

Nome de exibição da entidade de segurança
emailAddress

string

Endereço de email do usuário
graphId

string

Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo de entidade de segurança
profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
userType

string

Tipo do usuário.