Item Lifecycle - Update Item

Tjeneste:
Workload Development
API-versjon:
v1

Kalt av Microsoft Fabric for oppdatering av et eksisterende element.
Ved elementoppdatering utfører Fabric grunnleggende valideringer og kaller opp denne API-en for å varsle arbeidsbelastningen. Arbeidsbelastningen forventes å utføre nødvendige valideringer, lagre elementmetadataene, tildele og/eller gratis ressurser og oppdatere metadatabufferen for fabric-elementet med elementrelasjoner og ETag.

Denne API-en må godta SubjectAndApp-godkjenning.

Tillatelser

Tillatelser kontrolleres av Microsoft Fabric.

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
itemId
 path True

string (uuid)

Element-ID-en.
itemType
 path True

string

Elementtypen.
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Topptekst for forespørsel

Navn Obligatorisk Type Beskrivelse
ActivityId True

string

En unik ID for å korrelere forespørselen med systemet når en bruker samhandler med arbeidsbelastningen.
RequestId True

string

En globalt unik ID som hjelper Fabric med å koordinere forespørselen din med loggene våre. Oppgi denne ID-en når du rapporterer et problem.
Authorization True

string

Et autorisasjonshode med to tokener som gjør det mulig for arbeidsbelastningen å validere forespørselens opprinnelse, gi brukerkontekst og ringe andre tjenester. Denne toppteksten har følgende format: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id True

string

Leier-ID-en til klienten som foretar forespørselen.

Brødtekst for forespørsel

Navn Type Beskrivelse
description

string

Elementbeskrivelsen.
displayName

string

maxLength: 256

Visningsnavnet for elementet. Kan ikke overskride 256 tegn.
updatePayload

object

Oppdater nyttelast som er spesifikk for arbeidsbelastningen og elementtypen. Sendt av elementredigeringsprogrammet eller som API-parameter for stoffautomatisering.

Svar

Navn Type Beskrivelse
200 OK

Oppdatert.
Other Status Codes

ErrorResponse

For feilforhold bør arbeidsbelastningen returnere en passende HTTP-feilstatuskode (4xx, 5xx) med detaljert feilinformasjon i svarteksten.

Eksempler

Update item example

Eksempelforespørsel

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

{
  "displayName": "New display name",
  "description": "New description"
}

Eksempelsvar

Statuskode:
200

Definisjoner

Navn Beskrivelse
ErrorExtendedInformation

Den utvidede feilinformasjonen.
ErrorResponse

Feilsvaret.
ErrorSource

Kilden til feilen.
NameValuePair

Et navneverdipar.
UpdateItemRequest

Oppdater innhold for elementforespørsel. Dette innholdet har PATCH-semantikk: For egenskaper som ikke er angitt (null), bør de gjeldende verdiene for elementet bevares.

ErrorExtendedInformation

Objekt

Den utvidede feilinformasjonen.

Navn Type Beskrivelse
additionalParameters

NameValuePair[]

En liste over flere parametere som er spesifikke for feilen.
errorCode

string

Feilkoden.
message

string

Feilmeldingen.
messageParameters

string[]

En liste over parametere som formaterer en lokalisert melding.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

Feilkoden.
isPermanent

boolean

Angir om feilen er permanent eller operasjonen kan prøves på nytt.
message

string

Feilmeldingen.
messageParameters

string[]

En liste over parametere som formaterer en lokalisert melding.
moreDetails

ErrorExtendedInformation[]

En liste over flere feildetaljer.
source

ErrorSource

Feilkilden.

ErrorSource

Opplisting

Kilden til feilen.

Verdi Beskrivelse
System
User
External

NameValuePair

Objekt

Et navneverdipar.

Navn Type Beskrivelse
name

string

Navnet.
value

string

Verdien.

UpdateItemRequest

Objekt

Oppdater innhold for elementforespørsel. Dette innholdet har PATCH-semantikk: For egenskaper som ikke er angitt (null), bør de gjeldende verdiene for elementet bevares.

Navn Type Beskrivelse
description

string

Elementbeskrivelsen.
displayName

string

maxLength: 256

Visningsnavnet for elementet. Kan ikke overskride 256 tegn.
updatePayload

object

Oppdater nyttelast som er spesifikk for arbeidsbelastningen og elementtypen. Sendt av elementredigeringsprogrammet eller som API-parameter for stoffautomatisering.