Apps - Get Report
Retorna o relatório especificado do aplicativo especificado.
Escopo necessário
Report.ReadWrite.All ou Report.Read.All
Limitações
Não há suporte para a autenticação da entidade de serviço.
GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/reports/{reportId}Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
app
|
path | True |
string uuid |
A ID do aplicativo |
|
report
|
path | True |
string uuid |
A ID do relatório |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OK |
Exemplos
Example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/reports/{reportId}Sample Response
{
"appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "66b2570c-d9d3-40b2-83d9-1095c6700041",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/reports/66b2570c-d9d3-40b2-83d9-1095c6700041",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=66b2570c-d9d3-40b2-83d9-1095c6700041&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ"
}Definições
| Nome | Description |
|---|---|
|
Principal |
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. |
|
Report |
Uma entrada correta de acesso de usuário do Power BI para um relatório |
|
Report |
O direito de acesso que o usuário tem para o relatório (nível de permissão) |
|
Service |
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) |
|
Subscription |
Um usuário de assinatura de email do Power BI |
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 |
| isOwnedByMe |
boolean |
Determine se o relatório é criado pelo usuário atual. |
| name |
string |
O nome do relatório |
| originalReportId |
string |
A ID de relatório real quando o workspace é publicado como um aplicativo. |
| reportType |
enum:
|
O tipo de relatório |
| subscriptions |
(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 |
(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 |
|
| 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 |
O tipo de entidade de segurança |
|
| profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação. |
|
| 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 |
| 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 |
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 |
O tipo de entidade de segurança |
|
| profile |
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. |