Del via

Item Lifecycle - On Create Item

Tjeneste:
Workload Development
API-version:
v1

Kaldes af Microsoft Fabric for at oprette et nyt element.
Ved elementoprettelse udfører Fabric grundlæggende valideringer, opretter elementet i klargøringstilstand og kalder denne API for at give arbejdsbelastningen besked. Arbejdsbelastningen forventes at udføre påkrævede valideringer, gemme elementmetadata, tildele påkrævede ressourcer og opdatere metadatacachen for Fabric-elementer med elementrelationer og ETag.

Denne API skal acceptere SubjectAndApp-godkendelse.

Tilladelser

Tilladelser kontrolleres af Microsoft Fabric.

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

URI-parametre

Name I Påkrævet Type Beskrivelse
itemId
 path True

string (uuid)

Element-id'et.
itemType
 path True

string

Elementtypen.
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.

Overskrift på anmodning

Name Påkrævet Type Beskrivelse
ActivityId True

string (uuid)

Et entydigt id til at korrelere anmodningen med dit system, når en bruger interagerer med din arbejdsbelastning.
RequestId True

string (uuid)

Et globalt entydigt id, der hjælper Fabric med at korrelere din anmodning med vores logge. Angiv dette id, når du rapporterer et problem.
Authorization True

string

En tokengodkendelsesheader, der gør det muligt for arbejdsbelastningen at validere anmodningens oprindelse, angive brugerkontekst og kalde andre tjenester. Denne header har følgende format: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id True

string (uuid)

Lejer-id'et for den klient, der foretager anmodningen.

Brødtekst for anmodning

Name Type Beskrivelse
definition

ItemDefinition

Repræsenterer den indbyggede definition af et element.

Svar

Name Type Beskrivelse
200 OK

Oprettet.
Other Status Codes

ErrorResponse

I forbindelse med fejlbetingelser skal arbejdsbelastningen returnere en passende HTTP-fejlstatuskode (4xx, 5xx) med detaljerede fejloplysninger i svarets brødtekst.

Eksempler

Create item example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
200

Definitioner

Name Beskrivelse
ErrorExtendedInformation

De udvidede fejloplysninger.
ErrorResponse

Fejlsvaret.
ErrorSource

Kilden til fejlen.
ItemDefinition

Repræsenterer den indbyggede definition af et element.
ItemDefinitionPart

Repræsenterer en del af en elementdefinition.
NameValuePair

Et navneværdipar.
OnCreateItemRequest

Anmod om brødtekst for at oprette en elementdefinition i en fjernarbejdsbelastning.

ErrorExtendedInformation

Objekt

De udvidede fejloplysninger.

Name Type Beskrivelse
additionalParameters

NameValuePair[]

En liste over yderligere parametre, der er specifikke for fejlen.
errorCode

string

Fejlkoden.
message

string

Fejlmeddelelsen.
messageParameters

string[]

En liste over parametre til formatering af en lokaliseret meddelelse.

ErrorResponse

Objekt

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Fejlkoden.
isPermanent

boolean

Angiver, om fejlen er permanent, eller om handlingen kan prøves igen.
message

string

Fejlmeddelelsen.
messageParameters

string[]

En liste over parametre til formatering af en lokaliseret meddelelse.
moreDetails

ErrorExtendedInformation[]

En liste over yderligere oplysninger om fejl.
source

ErrorSource

Kilden til fejlen.

ErrorSource

Optælling

Kilden til fejlen.

Værdi Beskrivelse
System

Fejlen stammer fra systemet.
User

Fejlen stammer fra brugerinput.
External

Fejlen stammer fra en ekstern kilde.

ItemDefinition

Objekt

Repræsenterer den indbyggede definition af et element.

Name Type Beskrivelse
parts

ItemDefinitionPart[]

Definitionsdelene.

ItemDefinitionPart

Objekt

Repræsenterer en del af en elementdefinition.

Name Type Beskrivelse
path

string

Stien til delen (f.eks. '.platform').
payload

string

Nyttedataene (indbygget Base64-indhold).
payloadType

string

Nyttedatatypen (f.eks. 'InlineBase64').

NameValuePair

Objekt

Et navneværdipar.

Name Type Beskrivelse
name

string

Navnet.
value

string

Værdien.

OnCreateItemRequest

Objekt

Anmod om brødtekst for at oprette en elementdefinition i en fjernarbejdsbelastning.

Name Type Beskrivelse
definition

ItemDefinition

Repræsenterer den indbyggede definition af et element.