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

Items - Create Report

Служба:
Report
Версия API:
v1

Создает отчет в указанной рабочей области.
Этот 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

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Обязательно Тип Описание
definition True

ReportDefinition

Общедоступное определение отчета.
displayName True

string

Отображаемое имя отчета. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
description

string

Описание отчета. Максимальная длина — 256 символов.
folderId

string (uuid)

Идентификатор папки. Если отчет не указан или значение NULL, отчет создается в рабочей области в качестве папки.

Ответы

Имя Тип Описание
201 Created

Report

Успешно создано
202 Accepted

Запрос принят, подготовка отчетов выполняется.

Заголовки

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

ErrorResponse

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

  • InvalidItemType — недопустимый тип элемента.

  • ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.

  • Поврежденный Payload — предоставленные полезные данные повреждены.

  • WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

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"
      }
    ]
  }
}

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

Код состояния:
201 
{
  "displayName": "Report 1",
  "description": "A report description.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Код состояния:
202 
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

Определения

Имя Описание
CreateReportRequest

Создание полезных данных запроса отчета.
ErrorRelatedResource

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

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

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

Представляет тег, примененный к элементу.
ItemType

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

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

Объект отчета.
ReportDefinition

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

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

CreateReportRequest

Object

Создание полезных данных запроса отчета.

Имя Тип Описание
definition

ReportDefinition

Общедоступное определение отчета.
description

string

Описание отчета. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя отчета. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
folderId

string (uuid)

Идентификатор папки. Если отчет не указан или значение NULL, отчет создается в рабочей области в качестве папки.

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

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

ItemTag

Object

Представляет тег, примененный к элементу.

Имя Тип Описание
displayName

string

Имя тега.
id

string (uuid)

Идентификатор тега.

ItemType

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

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

Значение Описание
ApacheAirflowJob

An ApacheAirflowJob.
CopyJob

Задание копирования.
Dashboard

Панель мониторинга PowerBI.
DataPipeline

Конвейер данных.
Dataflow

Поток данных.
Datamart

Datamart PowerBI.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Поток Конструктора цифровых двойников.
Environment

Среда.
Eventhouse

Хранилище событий.
Eventstream

Поток событий.
GraphQLApi

API для элемента GraphQL.
KQLDashboard

Панель мониторинга KQL.
KQLDatabase

База данных KQL.
KQLQueryset

Набор запросов KQL.
Lakehouse

Озеро.
MLExperiment

Эксперимент машинного обучения.
MLModel

Модель машинного обучения.
MirroredAzureDatabricksCatalog

Зеркальный каталог azure databricks.
MirroredDatabase

Зеркальная база данных.
MirroredWarehouse

Зеркальный склад.
MountedDataFactory

ПодключеннаяdataFactory.
Notebook

Записная книжка.
PaginatedReport

Отчет с разбивкой на страницы PowerBI.
Reflex

Рефлекс.
Report

Отчет PowerBI.
SQLDatabase

База данных SQLDatabase.
SQLEndpoint

Конечная точка SQL.
SemanticModel

Семантическая модель PowerBI.
SparkJobDefinition

Определение задания Spark.
VariableLibrary

ПеременнаяLibrary.
Warehouse

Склад.
WarehouseSnapshot

Моментальный снимок хранилища.

PayloadType

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

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

Значение Описание
InlineBase64

Встроенная база 64.

Report

Object

Объект отчета.

Имя Тип Описание
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
folderId

string (uuid)

Идентификатор папки.
id

string (uuid)

Идентификатор элемента.
tags

ItemTag[]

Список примененных тегов.
type

ItemType

Тип элемента.
workspaceId

string (uuid)

Идентификатор рабочей области.

ReportDefinition

Object

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

Имя Тип Описание
format

string

Формат определения элемента.
parts

ReportDefinitionPart[]

Список частей определения.

ReportDefinitionPart

Object

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

Имя Тип Описание
path

string

Путь к части отчета.
payload

string

Полезные данные части отчета.
payloadType

PayloadType

Тип полезных данных.