Items - Get Item Definition

Служба:: Core

Версия API:: v1

Возвращает указанное определение элемента.
Этот API поддерживается для ряда типов элементов, найдите поддерживаемые типы элементов и сведения о их структуре определения в обзоре определения элемента. При получении определения элемента метка конфиденциальности не является частью определения.

Этот API поддерживает длительные операции (LRO).

Разрешения

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

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

Для API элементов используются следующие типы областей:

Универсальная область: Item.ReadWrite.All
Конкретная область: itemType. ReadWrite.All (например: Notebook.ReadWrite.All)

Дополнительные сведения о областях см. в статье "Области".

Ограничения

Этот API блокируется для элемента с защищенной меткой конфиденциальности, если вызывающий объект не имеет прав на использование для удаления метки конфиденциальности.

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

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

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Если тип элемента в вызове поддерживается. Проверьте соответствующий API для вызываемого типа элемента, чтобы узнать, поддерживается ли ваш вызов. Например, поддерживаются семантические модели.

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	ItemDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get an item definition example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/items/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	Сведения об ответе на ошибку.
ItemDefinition	Объект определения элемента.
ItemDefinitionPart	Объект части определения элемента.
ItemDefinitionResponse	Ответ общедоступного определения элемента.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

ItemDefinition

Объект

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

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

ItemDefinitionPart

Объект

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

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

ItemDefinitionResponse

Объект

Ответ общедоступного определения элемента.

Имя	Тип	Описание
definition	ItemDefinition	Объект определения элемента.

PayloadType

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

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

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