通过

Item Lifecycle - Create Item

服务:
Workload Development
API 版本:
v1

由 Microsoft Fabric 调用以创建新项。
项目创建构造执行基本验证后，创建处于预配状态的项并调用此 API 来通知工作负荷。 工作负荷应执行所需的验证、存储项元数据、分配所需的资源，以及使用项关系和 ETag 更新 Fabric 项元数据缓存。

此 API 应接受 SubjectAndApp 身份验证。

权限

Microsoft Fabric 检查权限。

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

URI 参数

名称 在 必需 类型 说明
itemId
 path True

string (uuid)

项 ID。
itemType
 path True

string

项类型。
workspaceId
 path True

string (uuid)

工作区 ID。

请求头

名称 必需 类型 说明
ActivityId True

string

当用户与工作负荷交互时，用于将请求与系统相关联的唯一 ID。
RequestId True

string

一个全局唯一 ID，可帮助 Fabric 将请求与我们的日志相关联。 报告问题时提供此 ID。
Authorization True

string

一个双令牌授权标头，允许工作负荷验证请求源、提供用户上下文和调用其他服务。 此标头的格式如下：SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"。
x-ms-client-tenant-id True

string

发出请求的客户端的租户 ID。

请求正文

名称 必需 类型 说明
displayName True

string

maxLength: 256

项显示名称。 不能超过 256 个字符。
creationPayload

object

特定于工作负荷和项类型的创建有效负载。 由项编辑器或作为 Fabric 自动化 API 参数传递。
description

string

项说明。

响应

名称 类型 说明
200 OK

已成功创建。
Other Status Codes

ErrorResponse

对于错误条件，工作负荷应返回相应的 HTTP 错误状态代码（4xx，5xx），并在响应正文中返回详细的错误信息。

示例

Create item example

示例请求

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

特定于工作负荷和项类型的创建有效负载。 由项编辑器或作为 Fabric 自动化 API 参数传递。
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

值。