Reports - Get Export To File Status In Group

Service:

Power BI REST APIs

API Version:

v1.0

Retorna o status atual do trabalho Exportar para Arquivo em Grupo para o relatório especificado do workspace especificado.

Quando o trabalho de exportação status for "Bem-sucedido", use a API GetFileOfExportToFile para recuperar o arquivo.

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

Report.ReadWrite.All ou Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/exports/{exportId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
exportId	path	True	string	A ID de exportação
groupId	path	True	string uuid	A ID do workspace
reportId	path	True	string uuid	A ID do relatório

Respostas

Nome	Tipo	Description
200 OK	Export	OK
202 Accepted	Export	Aceito

Exemplos

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/exports/{exportId}

Sample Response

Status code:

200

{
  "id": "Mi9C5419i....PS4=",
  "createdDateTime": "2021-12-08T10:26:09.3069086Z",
  "lastActionDateTime": "2021-12-08T10:26:38.016851Z",
  "reportId": "cad51cfa-e740-324f-acbb-8ca43c40a2d4",
  "reportName": "Report name",
  "status": "Succeeded",
  "percentComplete": 100,
  "resourceLocation": "...Mi9C5419i....PS4=/file",
  "resourceFileExtension": ".pptx",
  "expirationTime": "2021-12-09T10:26:11.586756Z"
}

Definições

Nome	Description
Export	Um objeto que descreve os detalhes e o estado atual de um trabalho de exportação para arquivo
ExportState	O estado atual do trabalho de exportação para arquivo

Export

Um objeto que descreve os detalhes e o estado atual de um trabalho de exportação para arquivo

Nome	Tipo	Description
ResourceFileExtension	string	A extensão do arquivo exportado
createdDateTime	string	A data e a hora de início do trabalho de exportação para o arquivo
expirationTime	string	A data e a hora de validade da URL de recuperação
id	string	A ID do trabalho de exportação para arquivo
lastActionDateTime	string	A data e a hora da última alteração para o trabalho de exportação para arquivo
percentComplete	integer	Progresso do trabalho como porcentagem
reportId	string	A ID do relatório exportado
reportName	string	O nome do relatório exportado
resourceLocation	string	A URL de recuperação para o arquivo exportado
status	ExportState	O estado atual do trabalho de exportação para arquivo

ExportState

O estado atual do trabalho de exportação para arquivo

Nome	Tipo	Description
Failed	string	Falha na exportação para o trabalho de arquivo
NotStarted	string	O trabalho de exportação para arquivo não foi iniciado
Running	string	O trabalho de exportação para arquivo está em execução
Succeeded	string	O trabalho de exportação para arquivo foi concluído com êxito
Undefined	string	O estado do trabalho de exportação para arquivo é indefinido