Compartilhar via


Imports - Post Import

Cria um novo conteúdo em Meude workspace.

Consulte o script Importar Arquivos Grandes PowerShell para obter um exemplo de como usar essa API.

Observação

Conteúdo com suporte:

  • Arquivos .pbix do Power BI
  • Arquivos JSON (.json)
  • Arquivos do Excel (.xlsx)
  • 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 codificar o arquivo como dados de formulário no corpo da solicitação.
  • Para importar o arquivo Paginated Reports(.rdl), inclua a extensão de arquivo .rdl no nome especificado por datasetDisplayName tal paginatedReport.rdl, conforme descrito nos parâmetros de URI. A extensão de arquivo no arquivo ajudará a distinguir o datasetDisplayName upload de Relatório Paginado(.rdl) de outros uploads.
  • Para importar um arquivo .xlsx do OneDrive for Business, inclua o tipo de conteúdo aplicativo/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. Isso só tem suporte para workspaces de capacidade Premium.
  • Para criar um fluxo de dados de um arquivo model.json, defina datasetDisplayName como model.json, conforme descrito em parâmetros de URI.

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 importar um arquivo .pbix do Power BI do OneDrive.
  • Não há suporte para importar um arquivo que tenha um protegido rótulo de confidencialidade para entidades de serviço.

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 URI

Nome Em Obrigatório Tipo Description
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 do OneDrive for Business.

nameConflict
query

ImportConflictHandlerMode

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

overrideModelLabel
query

boolean

Se deve substituir o rótulo existente em um modelo ao republicar um arquivo .pbix do Power BI. O valor padrão do serviço é true.

overrideReportLabel
query

boolean

Se deve substituir o rótulo de relatório existente 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 deve ser true. Só há suporte para arquivos .pbix do Power BI.

subfolderObjectId
query

string (uuid)

A ID da subpasta para importar o arquivo para a subpasta.

Corpo da solicitação

Nome Tipo Description
connectionType

connectionType

O tipo de conexão de importação para um arquivo do 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

OKEY

202 Accepted

Import

Aceitado

Exemplos

Import dataflow example
Post import example
Post import with 'skipReport' example

Import dataflow example

Solicitação de exemplo

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

Resposta de exemplo

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

Post import example

Solicitação de exemplo

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

Resposta de exemplo

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

Post import with 'skipReport' example

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
connectionType

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

Dataset

Um conjunto de dados do Power BI. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. 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 certa 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 da criptografia do conjunto de dados

Import

O objeto de importação

ImportConflictHandlerMode

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

ImportInfo

As informações sobre a importação

PrincipalType

O tipo principal

Report

Um relatório do Power BI. A API retorna um subconjunto da lista a seguir de propriedades de relatório. 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 certa 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 perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

Subscription

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

SubscriptionUser

Um usuário de assinatura de email do Power BI

connectionType

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

Valor Description
connect
import

Dataset

Um conjunto de dados do Power BI. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. 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

Uma propriedade preterida que deve ser ignorada.

Encryption

Encryption

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

IsEffectiveIdentityRequired

boolean

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

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

Esse campo retorna true quando o conjunto de dados é atualizado recentemente ou está configurado para atualização automática, com o modo de conexão definido especificamente como "Importar". O valor retornará false para outros modos de conexão, como 'DirectQuery' e 'LiveConnection', independentemente de o conjunto de dados ser atualizado manualmente ou ser configurado para atualização automática.

addRowsAPIEnabled

boolean

Se o conjunto de dados permite adicionar novas linhas

configuredBy

string

O proprietário do conjunto de dados

createReportEmbedURL

string

O conjunto de dados cria a URL de inserção de relatório

createdDate

string (date-time)

A data e a hora de criação 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

qnaEmbedURL

string

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

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 de 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 painel) usando o Obter Usuários do Conjunto de Dados como Administrador API ou a API PostWorkspaceInfo com o parâmetro getArtifactUsers.

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

minimum: -1
maximum: 64

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 certa 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 principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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)

Valor Description
None

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

Read

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

ReadExplore

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

ReadReshare

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

ReadReshareExplore

Concede acesso de leitura, compartilhamento e exploração ao conteúdo no conjunto de dados

ReadWrite

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

ReadWriteExplore

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

ReadWriteReshare

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

ReadWriteReshareExplore

Concede acesso de leitura, gravação, compartilhamento 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 da criptografia do conjunto de dados

EncryptionStatus

Status da criptografia do conjunto de dados

Valor Description
InSyncWithWorkspace

A criptografia tem suporte e está em sincronia com as configurações de criptografia

NotInSyncWithWorkspace

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

NotSupported

Não há suporte para criptografia para esse conjunto de dados

Unknown

O status de criptografia é desconhecido devido à corrupção do conjunto de dados

Import

O objeto de importação

Nome Tipo Description
createdDateTime

string (date-time)

Data e hora de criação de importação

datasets

Dataset[]

Os conjuntos de dados associados a essa importação

id

string (uuid)

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 (date-time)

Importar data e hora da última atualização

ImportConflictHandlerMode

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

Valor Description
Abort

Se já existir um conjunto de dados com o mesmo nome, a operação de importação será cancelada.

CreateOrOverwrite

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

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

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

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 do 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 principal

Valor Description
App

Tipo de entidade de serviço

Group

Tipo de entidade de grupo

None

Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização.

User

Tipo de entidade de usuário

Report

Um relatório do Power BI. A API retorna um subconjunto da lista a seguir de propriedades de relatório. 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 (uuid)

A ID do relatório

isOwnedByMe

boolean

Indica se o usuário atual tem a capacidade de modificar ou criar uma cópia do relatório.

name

string

O nome do relatório. Os relatórios do aplicativo começam com o prefixo [App].

originalReportId

string (uuid)

A ID do 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 painel). Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações de assinatura para um relatório do Power BI usando o Obter Assinaturas de Relatório como Administrador chamada à 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 de conteúdo em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando o Obter Usuários de Relatório como administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro getArtifactUsers.

webUrl

string

A URL da Web do relatório

ReportUser

Uma entrada certa 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 principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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)

Valor Description
None

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

Owner

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

Read

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

ReadCopy

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

ReadReshare

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

ReadWrite

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

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço

id

string (uuid)

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 painel)

Nome Tipo Description
artifactDisplayName

string

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

artifactId

string (uuid)

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

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 (date-time)

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

frequency

string

A frequência da assinatura de email

id

string (uuid)

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 (date-time)

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 o obter assinaturas de usuário como administrador chamada à API, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações de assinatura em um relatório ou dashboard do Power BI usando o Obter Assinaturas de Relatório como Administrador ou Obter Assinaturas do Painel como Administrador chamadas à API.

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 principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

userType

string

Tipo do usuário.