Freigeben über

Item Lifecycle - On 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 durch Microsoft Fabric überprüft.

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

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 (uuid)

Eine eindeutige ID zum Korrelieren der Anforderung mit Ihrem System, wenn ein Benutzer mit Ihrer Workload interagiert.
RequestId True

string (uuid)

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 (uuid)

Die Mandanten-ID des Clients, der die Anforderung stellt.

Anforderungstext

Name Typ Beschreibung
definition

ItemDefinition

Stellt die Inlinedefinition eines Elements dar.

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

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

{
  "definition": {
    "parts": [
      {
        "path": ".platform",
        "payload": "eyJuYW1lIjogIk15IERhdGEgV2FyZWhvdXNlIn0=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
200

Definitionen

Name Beschreibung
ErrorExtendedInformation

Die erweiterten Fehlerinformationen.
ErrorResponse

Die Fehlerantwort.
ErrorSource

Die Ursache des Fehlers.
ItemDefinition

Stellt die Inlinedefinition eines Elements dar.
ItemDefinitionPart

Stellt einen Teil einer Elementdefinition dar.
NameValuePair

Ein Name-Wert-Paar.
OnCreateItemRequest

Anforderungstext zum Erstellen einer Elementdefinition in einer Remoteworkload.

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 Ursache des Fehlers.

ErrorSource

Enumeration

Die Ursache des Fehlers.

Wert Beschreibung
System

Der Fehler stammt aus dem System.
User

Der Fehler stammt von der Benutzereingabe.
External

Der Fehler stammt aus einer externen Quelle.

ItemDefinition

Objekt

Stellt die Inlinedefinition eines Elements dar.

Name Typ Beschreibung
parts

ItemDefinitionPart[]

Die Definitionsteile.

ItemDefinitionPart

Objekt

Stellt einen Teil einer Elementdefinition dar.

Name Typ Beschreibung
path

string

Der Pfad des Teils (z. B. ".platform").
payload

string

Die Nutzlast (inline Base64-Inhalt).
payloadType

string

Der Nutzlasttyp (z. B. "InlineBase64").

NameValuePair

Objekt

Ein Name-Wert-Paar.

Name Typ Beschreibung
name

string

Der Name.
value

string

Der -Wert.

OnCreateItemRequest

Objekt

Anforderungstext zum Erstellen einer Elementdefinition in einer Remoteworkload.

Name Typ Beschreibung
definition

ItemDefinition

Stellt die Inlinedefinition eines Elements dar.