Item Lifecycle - Create Item

サービス:

Workload Development

API バージョン:

v1

新しい項目を作成するために Microsoft Fabric によって呼び出されます。
項目の作成時に 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	Fabric が要求をログと関連付けるのに役立つグローバルに一意の ID。 問題を報告するときに、この 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

要求のサンプル

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	ワークロードと項目の種類に固有の作成ペイロード。 項目エディターまたは 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	値。