Item Lifecycle - On Create Item

Tjänst:: Workload Development

API-version:: v1

Anropas av Microsoft Fabric för att skapa ett nytt objekt.
När objektet skapas utför Infrastrukturresurser grundläggande valideringar, skapar objektet i etableringstillstånd och anropar det här API:et för att meddela arbetsbelastningen. Arbetsbelastningen förväntas utföra nödvändiga valideringar, lagra objektmetadata, allokera nödvändiga resurser och uppdatera metadatacachen för infrastrukturobjekt med objektrelationer och ETag.

Det här API:et bör acceptera SubjectAndApp-autentisering.

behörigheter

Behörigheter kontrolleras av Microsoft Fabric.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
itemId	path	True	string (uuid)	Objekt-ID:t.
itemType	path	True	string	Objekttypen.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Begärandehuvud

Name	Obligatorisk	Typ	Description
ActivityId	True	string (uuid)	Ett unikt ID för att korrelera begäran med systemet när en användare interagerar med din arbetsbelastning.
RequestId	True	string (uuid)	Ett globalt unikt ID som hjälper Fabric att korrelera din begäran med våra loggar. Ange det här ID:t när du rapporterar ett problem.
Authorization	True	string	Ett auktoriseringshuvud med dubbla token som gör att arbetsbelastningen kan verifiera begärans ursprung, tillhandahålla användarkontext och anropa andra tjänster. Den här rubriken har följande format: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Klientorganisations-ID:t för klienten som skickar begäran.

Begärandetext

Name	Typ	Description
definition	ItemDefinition	Representerar den infogade definitionen av ett objekt.

Svar

Name	Typ	Description
200 OK		Har skapats.
Other Status Codes	ErrorResponse	För feltillstånd ska arbetsbelastningen returnera en lämplig HTTP-felstatuskod (4xx, 5xx) med detaljerad felinformation i svarstexten.

Exempel

Create item example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

Definitioner

Name	Description
ErrorExtendedInformation	Den utökade felinformationen.
ErrorResponse	Felsvaret.
ErrorSource	Källan till felet.
ItemDefinition	Representerar den infogade definitionen av ett objekt.
ItemDefinitionPart	Representerar en del av en objektdefinition.
NameValuePair	Ett namn/värde-par.
OnCreateItemRequest	Begärandetext för att skapa en objektdefinition i en fjärrarbetsbelastning.

ErrorExtendedInformation

Objekt

Den utökade felinformationen.

Name	Typ	Description
additionalParameters	NameValuePair[]	En lista över ytterligare parametrar som är specifika för felet.
errorCode	string	Felkoden.
message	string	Felmeddelandet.
messageParameters	string[]	En lista med parametrar för formatering av ett lokaliserat meddelande.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	Felkoden.
isPermanent	boolean	Anger om felet är permanent eller om åtgärden kan utföras igen.
message	string	Felmeddelandet.
messageParameters	string[]	En lista med parametrar för formatering av ett lokaliserat meddelande.
moreDetails	ErrorExtendedInformation[]	En lista med ytterligare felinformation.
source	ErrorSource	Källan till felet.

ErrorSource

Uppräkning

Källan till felet.

Värde	Description
System	Felet kom från systemet.
User	Felet kommer från användarindata.
External	Felet kom från en extern källa.

ItemDefinition

Objekt

Representerar den infogade definitionen av ett objekt.

Name	Typ	Description
parts	ItemDefinitionPart[]	Definitionsdelarna.

ItemDefinitionPart

Objekt

Representerar en del av en objektdefinition.

Name	Typ	Description
path	string	Sökvägen till delen (t.ex. ".platform").
payload	string	Nyttolasten (infogat Base64-innehåll).
payloadType	string	Nyttolasttypen (t.ex. "InlineBase64").

NameValuePair

Objekt

Ett namn/värde-par.

Name	Typ	Description
name	string	Namnet.
value	string	Värdet.

OnCreateItemRequest

Objekt

Begärandetext för att skapa en objektdefinition i en fjärrarbetsbelastning.

Name	Typ	Description
definition	ItemDefinition	Representerar den infogade definitionen av ett objekt.