Item Lifecycle - Create Item

Служба:

Workload Development

Версия API:

v1

Вызывается Microsoft Fabric для создания нового элемента.
После создания элемента Fabric выполняет основные проверки, создает элемент в состоянии подготовки и вызывает этот API для уведомления рабочей нагрузки. Ожидается, что рабочая нагрузка будет выполнять необходимые проверки, хранить метаданные элемента, выделять необходимые ресурсы и обновлять кэш метаданных элементов Fabric с отношениями элементов и ETag.

Этот API должен принимать проверку подлинности SubjectAndApp.

Разрешения

Разрешения проверяются Microsoft Fabric.

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}

Параметры URI

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

Заголовок запроса

Имя	Обязательно	Тип	Описание
ActivityId	True	string	Уникальный идентификатор для сопоставления запроса с системой при взаимодействии пользователя с рабочей нагрузкой.
RequestId	True	string	Глобальный уникальный идентификатор, который помогает Fabric сопоставлять запрос с нашими журналами. Укажите этот идентификатор при создании отчетов о проблеме.
Authorization	True	string	Заголовок авторизации двойного токена, позволяющий рабочей нагрузке проверять источник запроса, предоставлять контекст пользователя и вызывать другие службы. Этот заголовок имеет следующий формат: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	Идентификатор клиента, выполняющего запрос.

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

Имя	Обязательно	Тип	Описание
displayName	True	string maxLength: 256	Отображаемое имя элемента. Не может превышать 256 символов.
creationPayload		object	Полезные данные создания, относящиеся к рабочей нагрузке и типу элементов. Передается редактором элементов или параметром API автоматизации Fabric.
description		string	Описание элемента.

Ответы

Имя	Тип	Описание
200 OK		Успешно создано.
Other Status Codes	ErrorResponse	Для условий ошибки рабочая нагрузка должна возвращать соответствующий код состояния ошибки HTTP (4xx, 5xx) с подробными сведениями об ошибке в тексте ответа.

Примеры

Create item example

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

HTTP

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111

{
  "displayName": "Forecast 1",
  "description": "The 1st forecast item",
  "creationPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

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

Код состояния:

200

Определения

Имя	Описание
CreateItemRequest	Создание содержимого запроса элемента.
ErrorExtendedInformation	Расширенные сведения об ошибке.
ErrorResponse	Ответ на ошибку.
ErrorSource	Источник ошибки.
NameValuePair	Пара "имя-значение".

CreateItemRequest

Object

Создание содержимого запроса элемента.

Имя	Тип	Описание
creationPayload	object	Полезные данные создания, относящиеся к рабочей нагрузке и типу элементов. Передается редактором элементов или параметром API автоматизации Fabric.
description	string	Описание элемента.
displayName	string maxLength: 256	Отображаемое имя элемента. Не может превышать 256 символов.

ErrorExtendedInformation

Object

Расширенные сведения об ошибке.

Имя	Тип	Описание
additionalParameters	NameValuePair[]	Список дополнительных параметров, относящихся к ошибке.
errorCode	string	Код ошибки.
message	string	Сообщение об ошибке.
messageParameters	string[]	Список параметров для форматирования локализованного сообщения.

ErrorResponse

Object

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

Имя	Тип	Описание
errorCode	string	Код ошибки.
isPermanent	boolean	Указывает, является ли ошибка постоянной или может быть выполнена повторная операция.
message	string	Сообщение об ошибке.
messageParameters	string[]	Список параметров для форматирования локализованного сообщения.
moreDetails	ErrorExtendedInformation[]	Список дополнительных сведений об ошибке.
source	ErrorSource	Источник ошибки.

ErrorSource

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

Источник ошибки.

Значение	Описание
System
User
External

NameValuePair

Object

Пара "имя-значение".

Имя	Тип	Описание
name	string	Имя.
value	string	Значение.