Item Lifecycle - Create Item

Dienst:

Workload Development

API-Version:

v1

Wird von Microsoft Fabric zum Erstellen eines neuen Elements aufgerufen.
Beim Erstellen von Elementen führt Fabric grundlegende Überprüfungen durch, erstellt das Element in einem Bereitstellungsstatus und ruft diese API auf, um die Workload zu benachrichtigen. Die Arbeitsauslastung wird erwartet, dass erforderliche Überprüfungen ausgeführt werden, die Elementmetadaten gespeichert, erforderliche Ressourcen zugewiesen und der Fabric-Elementmetadatencache mit Elementbeziehungen und ETag aktualisiert wird.

Diese API sollte die SubjectAndApp-Authentifizierung akzeptieren.

Erlaubnisse

Berechtigungen werden von Microsoft Fabric überprüft.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID.
itemType	path	True	string	Der Elementtyp.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
ActivityId	True	string	Eine eindeutige ID zum Korrelieren der Anforderung mit Ihrem System, wenn ein Benutzer mit Ihrer Workload interagiert.
RequestId	True	string	Eine global eindeutige ID, die Fabric dabei hilft, Ihre Anforderung mit unseren Protokollen zu korrelieren. Geben Sie diese ID an, wenn ein Problem gemeldet wird.
Authorization	True	string	Ein Dual-Token-Autorisierungsheader, der es der Workload ermöglicht, den Anforderungsursprung zu überprüfen, Den Benutzerkontext bereitzustellen und andere Dienste aufzurufen. Diese Kopfzeile hat das folgende Format: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	Die Mandanten-ID des Clients, der die Anforderung stellt.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
displayName	True	string maxLength: 256	Der Anzeigename des Elements. 256 Zeichen dürfen nicht überschritten werden.
creationPayload		object	Erstellungsnutzlast speziell für die Workload und den Elementtyp. Wird vom Element-Editor oder als Fabric-Automatisierungs-API-Parameter übergeben.
description		string	Die Elementbeschreibung.

Antworten

Name	Typ	Beschreibung
200 OK		Erfolgreich erstellt.
Other Status Codes	ErrorResponse	Bei Fehlerbedingungen sollte die Workload einen entsprechenden HTTP-Fehlerstatuscode (4xx, 5xx) mit detaillierten Fehlerinformationen im Antworttext zurückgeben.

Beispiele

Create item example

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
CreateItemRequest	Elementanforderungsinhalt erstellen.
ErrorExtendedInformation	Die erweiterten Fehlerinformationen.
ErrorResponse	Die Fehlerantwort.
ErrorSource	Die Quelle des Fehlers.
NameValuePair	Ein Name-Wert-Paar.

CreateItemRequest

Objekt

Elementanforderungsinhalt erstellen.

Name	Typ	Beschreibung
creationPayload	object	Erstellungsnutzlast speziell für die Workload und den Elementtyp. Wird vom Element-Editor oder als Fabric-Automatisierungs-API-Parameter übergeben.
description	string	Die Elementbeschreibung.
displayName	string maxLength: 256	Der Anzeigename des Elements. 256 Zeichen dürfen nicht überschritten werden.

ErrorExtendedInformation

Objekt

Die erweiterten Fehlerinformationen.

Name	Typ	Beschreibung
additionalParameters	NameValuePair[]	Eine Liste mit zusätzlichen Parametern, die für den Fehler spezifisch sind.
errorCode	string	Der Fehlercode.
message	string	Die Fehlermeldung.
messageParameters	string[]	Eine Liste der Parameter zum Formatieren einer lokalisierten Nachricht.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
isPermanent	boolean	Gibt an, ob der Fehler dauerhaft ist oder der Vorgang wiederholt werden kann.
message	string	Die Fehlermeldung.
messageParameters	string[]	Eine Liste der Parameter zum Formatieren einer lokalisierten Nachricht.
moreDetails	ErrorExtendedInformation[]	Eine Liste mit zusätzlichen Fehlerdetails.
source	ErrorSource	Die Fehlerquelle.

ErrorSource

Enumeration

Die Quelle des Fehlers.

Wert	Beschreibung
System
User
External

NameValuePair

Objekt

Ein Name-Wert-Paar.

Name	Typ	Beschreibung
name	string	Der Name.
value	string	Der Wert.