Items - Get Report Definition

Служба:: Report

Версия API:: v1

Возвращает указанное общедоступное определение отчета.
Этот API поддерживает длительные операции (LRO).

При получении общедоступного определения отчета метка конфиденциальности не является частью определения.

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для отчета.

Обязательные делегированные области

Report.ReadWrite.All или Item.ReadWrite.All

Ограничения

Этот API заблокирован для отчета с зашифрованной меткой конфиденциальности.

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
reportId	path	True	string (uuid)	Идентификатор отчета.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
format	query		string	Формат общедоступного определения отчета.

Ответы

Имя	Тип	Описание
200 OK	ReportDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Имя

Тип

Описание

200 OK

ReportDefinitionResponse

Запрос успешно завершен.

202 Accepted

Запрос принят. Получение определения выполняется.

Заголовки

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a report definition example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Код состояния:: 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

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
ReportDefinition	Отчет об объекте общедоступного определения. Дополнительные сведения о создании общедоступного определения отчета см. в этой статье.
ReportDefinitionPart	Объект части определения отчета.
ReportDefinitionResponse	Сообщите об ответе на общедоступное определение.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.

ReportDefinition

Object

Отчет об объекте общедоступного определения. Дополнительные сведения о создании общедоступного определения отчета см. в этой статье.

Имя	Тип	Описание
format	string	Формат определения элемента.
parts	ReportDefinitionPart[]	Список частей определения.

ReportDefinitionPart

Object

Объект части определения отчета.

Имя	Тип	Описание
path	string	Путь к части отчета.
payload	string	Полезные данные части отчета.
payloadType	PayloadType	Тип полезных данных.

ReportDefinitionResponse

Object

Сообщите об ответе на общедоступное определение.

Имя	Тип	Описание
definition	ReportDefinition	Отчет об объекте общедоступного определения. Дополнительные сведения о создании общедоступного определения отчета см. в этой статье.

Поделиться через

Items - Get Report Definition

Разрешения

Обязательные делегированные области

Ограничения

Идентификаторы, поддерживаемые Microsoft Entra

Интерфейс

Параметры URI

Ответы

Примеры

Get a report definition example

Образец запроса

Пример ответа

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PayloadType

ReportDefinition

ReportDefinitionPart

ReportDefinitionResponse