Partilhar via

Items - Get Report Definition

Serviço:
Report
Versão da API:
v1

Retorna a definição pública de relatório especificada.
Esta API suporta operações de longa duração (LRO).

Quando você obtém a definição pública de um relatório, o rótulo de sensibilidade não faz parte da definição.

Permissões

O chamador deve ter permissões de leitura e gravação para o relatório.

Escopos delegados necessários

Report.ReadWrite.All ou Item.ReadWrite.All

Limitações

Essa API está bloqueada para um relatório com um rótulo de sensibilidade criptografado.

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Sim

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition

Parâmetros do URI

Name Em Necessário Tipo Description
reportId
 path True

string (uuid)

O ID do relatório.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Respostas

Name Tipo Description
200 OK

ReportDefinitionResponse

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. Está em curso a recuperação da definição.

Cabeçalhos

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get a report definition example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Resposta da amostra

Código de estado:
200 
{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
PayloadType

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
ReportDefinition

Objeto de definição pública de relatório. Consulte este artigo para obter mais detalhes sobre como elaborar uma definição pública de relatório.
ReportDefinitionPart

Objeto de parte de definição de relatório.
ReportDefinitionResponse

Relatar resposta de definição pública.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor Description
InlineBase64

Base em linha 64.

ReportDefinition

Object

Objeto de definição pública de relatório. Consulte este artigo para obter mais detalhes sobre como elaborar uma definição pública de relatório.

Name Tipo Description
format

string

O formato da definição do item.
parts

ReportDefinitionPart[]

Uma lista de partes de definição.

ReportDefinitionPart

Object

Objeto de parte de definição de relatório.

Name Tipo Description
path

string

O caminho da parte do relatório.
payload

string

O relatório parte da carga útil.
payloadType

PayloadType

O tipo de carga útil.

ReportDefinitionResponse

Object

Relatar resposta de definição pública.

Name Tipo Description
definition

ReportDefinition

Objeto de definição pública de relatório. Consulte este artigo para obter mais detalhes sobre como elaborar uma definição pública de relatório.