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

Items - Update Report

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

Обновляет свойства указанного отчета.

Разрешения

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

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

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

Поддерживаемые удостоверения Microsoft Entra

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

Тождество Поддержка
Пользователь Да
субъекта-службы и управляемых удостоверений Да

Интерфейс

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

Параметры URI

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

string

uuid

Идентификатор отчета.
workspaceId
 path True

string

uuid

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

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

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

string

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

string

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

Ответы

Имя Тип Описание
200 OK

Report

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

ErrorResponse

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

  • ItemNotFound — запрошенный элемент не найден.

  • InvalidRequest — недопустимый запрос на обновление

Примеры

Update a report example

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

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff211/reports/5b218778-e7a5-4d73-8187-f10824047721

{
  "displayName": "Report's New name",
  "description": "A new description for report."
}

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

Код состояния:
200 
{
  "displayName": "Report's New name",
  "description": "A new description for report.",
  "type": "Report",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff211",
  "id": "5b218778-e7a5-4d73-8187-f10824047721"
}

Определения

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

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

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

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

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

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

Обновление запроса отчета.

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

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

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

Склад.

Report

Object

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

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

string

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

string

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

string

uuid

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

ItemType

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

string

uuid

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

UpdateReportRequest

Object

Обновление запроса отчета.

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

string

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

string

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