Items - Create Report
Создает отчет в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).
Для этого API требуется определение .
Разрешения
Вызывающий объект должен иметь участника или более поздней роли рабочей области.
Обязательные делегированные области
Report.ReadWrite.All или Item.ReadWrite.All
Ограничения
- Чтобы создать элемент отчета, пользователь должен иметь соответствующую лицензию. Дополнительные сведения см. в статье типов лицензий Microsoft Fabric.
Поддерживаемые удостоверения Microsoft Entra
Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.
Тождество | Поддержка |
---|---|
Пользователь | Да |
субъекта-службы и управляемых удостоверений | Да |
Интерфейс
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
Идентификатор рабочей области. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
definition | True |
Общедоступное определение отчета. |
|
displayName | True |
string |
Отображаемое имя отчета. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента. |
description |
string |
Описание отчета. Максимальная длина — 256 символов. |
Ответы
Имя | Тип | Описание |
---|---|---|
201 Created |
Успешно создано |
|
202 Accepted |
Запрос принят, подготовка отчетов выполняется. Заголовки
|
|
Other Status Codes |
Распространенные коды ошибок:
|
Примеры
Create a report example
Образец запроса
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/reports
{
"displayName": "Report 1",
"description": "A report description.",
"definition": {
"parts": [
{
"path": "definition.pbir",
"payload": "ew0KICAidmVyc2lvbiI..sYVN0eWxlTGl2ZSINCiAgICB9DQogIH0NCn0=",
"payloadType": "InlineBase64"
},
{
"path": "report.json",
"payload": "ewogICJjb25maWciOiA..3aWR0aCI6IDEyODAuMDAKICAgIH0KICBdCn0=",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Пример ответа
{
"displayName": "Report 1",
"description": "A report description.",
"type": "Report",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30
Определения
Имя | Описание |
---|---|
Create |
Создание полезных данных запроса отчета. |
Error |
Объект сведений об ошибках, связанных с ресурсом. |
Error |
Ответ на ошибку. |
Error |
Сведения об ответе на ошибку. |
Item |
Тип элемента. С течением времени могут добавляться дополнительные типы элементов. |
Payload |
Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных. |
Report |
Объект отчета. |
Report |
Отчет об объекте общедоступного определения. Дополнительные сведения о создании общедоступного определения отчета см. в этой статье. |
Report |
Объект части определения отчета. |
CreateReportRequest
Создание полезных данных запроса отчета.
Имя | Тип | Описание |
---|---|---|
definition |
Общедоступное определение отчета. |
|
description |
string |
Описание отчета. Максимальная длина — 256 символов. |
displayName |
string |
Отображаемое имя отчета. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента. |
ErrorRelatedResource
Объект сведений об ошибках, связанных с ресурсом.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса, участвующий в ошибке. |
resourceType |
string |
Тип ресурса, который участвует в ошибке. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
moreDetails |
Список дополнительных сведений об ошибке. |
|
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
|
requestId |
string |
Идентификатор запроса, связанного с ошибкой. |
ErrorResponseDetails
Сведения об ответе на ошибку.
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями. |
message |
string |
Удобочитаемое представление ошибки. |
relatedResource |
Сведения об ошибках, связанных с ресурсом. |
ItemType
Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Значение | Описание |
---|---|
Dashboard |
Панель мониторинга PowerBI. |
DataPipeline |
Конвейер данных. |
Datamart |
Datamart PowerBI. |
Environment |
Среда. |
Eventhouse |
Хранилище событий. |
Eventstream |
Поток событий. |
GraphQLApi |
API для элемента GraphQL. |
KQLDashboard |
Панель мониторинга KQL. |
KQLDatabase |
База данных KQL. |
KQLQueryset |
Набор запросов KQL. |
Lakehouse |
Озеро. |
MLExperiment |
Эксперимент машинного обучения. |
MLModel |
Модель машинного обучения. |
MirroredDatabase |
Зеркальная база данных. |
MirroredWarehouse |
Зеркальный склад. |
MountedDataFactory |
ПодключеннаяdataFactory. |
Notebook |
Записная книжка. |
PaginatedReport |
Отчет с разбивкой на страницы PowerBI. |
Reflex |
Рефлекс. |
Report |
Отчет PowerBI. |
SQLDatabase |
База данных SQLDatabase. |
SQLEndpoint |
Конечная точка SQL. |
SemanticModel |
Семантическая модель PowerBI. |
SparkJobDefinition |
Определение задания Spark. |
Warehouse |
Склад. |
PayloadType
Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
Значение | Описание |
---|---|
InlineBase64 |
Встроенная база 64. |
Report
Объект отчета.
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание элемента. |
displayName |
string |
Отображаемое имя элемента. |
id |
string uuid |
Идентификатор элемента. |
type |
Тип элемента. |
|
workspaceId |
string uuid |
Идентификатор рабочей области. |
ReportDefinition
Отчет об объекте общедоступного определения. Дополнительные сведения о создании общедоступного определения отчета см. в этой статье.
Имя | Тип | Описание |
---|---|---|
format |
string |
Формат определения элемента. |
parts |
Список частей определения. |
ReportDefinitionPart
Объект части определения отчета.
Имя | Тип | Описание |
---|---|---|
path |
string |
Путь к части отчета. |
payload |
string |
Полезные данные части отчета. |
payloadType |
Тип полезных данных. |