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

Items - Create Item

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

Создает элемент в указанной рабочей области.
Этот API поддерживается для ряда типов элементов, найдите поддерживаемые типы элементов в обзоре управления элементами. Чтобы получить определение элемента, можно использовать API определения элементов.

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

Разрешения

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

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

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

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

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

Ограничения

  • Чтобы создать элемент, отличный от PowerBI Fabric, рабочая область должна находиться в поддерживаемой емкости Fabric. Дополнительные сведения см. в типах лицензий Microsoft Fabric.
  • Чтобы создать элемент PowerBI, пользователь должен иметь соответствующую лицензию. Дополнительные сведения см. в типах лицензий Microsoft Fabric.
  • При создании элемента используйте creationPayload или definition, но не используйте оба одновременно.

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

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

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

Интерфейс

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

Параметры URI

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

string

uuid

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

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

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

string

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

ItemType

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

object

Набор свойств, используемых для создания элемента. Страница создания элемента соответствующего типа указывает, поддерживается ли creationPayload и перечисляется ли свойства элемента. Используйте creationPayload или definition. Вы не можете использовать оба одновременно.
definition

ItemDefinition

Определение элемента. Страница создания элемента соответствующего типа указывает, поддерживается ли определение и подробно его структура. Используйте definition или creationPayload. Вы не можете использовать оба одновременно.
description

string

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

Ответы

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

Item

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

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

Заголовки

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

ErrorResponse

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

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

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

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

Примеры

Create an item example

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

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

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

Код состояния:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "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

Определения

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

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

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

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

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

Объект элемента.
ItemDefinition

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

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

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

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

CreateItemRequest

Object

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

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

object

Набор свойств, используемых для создания элемента. Страница создания элемента соответствующего типа указывает, поддерживается ли creationPayload и перечисляется ли свойства элемента. Используйте creationPayload или definition. Вы не можете использовать оба одновременно.
definition

ItemDefinition

Определение элемента. Страница создания элемента соответствующего типа указывает, поддерживается ли определение и подробно его структура. Используйте definition или creationPayload. Вы не можете использовать оба одновременно.
description

string

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

string

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

ItemType

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

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

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

Item

Object

Объект элемента.

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

string

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

string

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

string

uuid

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

ItemType

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

string

uuid

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

ItemDefinition

Object

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

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

string

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

ItemDefinitionPart[]

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

ItemDefinitionPart

Object

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

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

string

Путь к части элемента.
payload

string

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

PayloadType

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

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.