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

Items - Update Report Definition

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

Переопределяет определение указанного отчета.
Этот API поддерживает длительные операции (LRO).

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

Разрешения

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

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

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

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

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

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/updateDefinition
С использованием необязательных параметров: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/updateDefinition?updateMetadata={updateMetadata}

Параметры URI

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

string (uuid)

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

string (uuid)

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

boolean

Если задано значение true и файл платформы предоставляется в рамках определения, метаданные элемента обновляются с помощью метаданных в файле платформы.

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

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

ReportDefinition

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

Ответы

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

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

Запрос принят. Определение обновления выполняется.

Заголовки

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

ErrorResponse

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

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

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

Примеры

Update a report definition example

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

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/reports/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

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

Код состояния:
200
Код состояния:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Определения

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

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

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

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

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

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

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

Обновление полезных данных запроса общедоступного определения отчета.

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

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

UpdateReportDefinitionRequest

Object

Обновление полезных данных запроса общедоступного определения отчета.

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

ReportDefinition

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