Item Lifecycle - On Update Item

Palvelu:: Workload Development

Ohjelmointirajapinnan versio:: v1

Microsoft Fabric soitti aiemmin luodun kohteen päivittämistä varten.
Kohteen päivityksen yhteydessä Fabric suorittaa perustason vahvistukset ja kutsuu tätä ohjelmointirajapintaa ilmoittaakseen kuormituksesta. Kuormituksen odotetaan suorittavan tarvittavat vahvistukset, tallentavan kohteen metatiedot, varaavan ja/tai maksuttoman resurssin sekä päivittävän Fabric-kohteen metatietovälimuistiin kohdesuhteet ja ETag-tiedot.

Tämän ohjelmointirajapinnan tulee hyväksyä SubjectAndApp-todennus.

Käyttöoikeudet

Microsoft Fabric tarkistaa oikeudet.

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
itemId	path	True	string (uuid)	Kohdetunnus.
itemType	path	True	string	Kohdetyyppi.
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön otsikko

Nimi	Pakollinen	Tyyppi	Description
ActivityId	True	string (uuid)	Yksilöivä tunnus pyynnön korreloimiseen järjestelmän kanssa, kun käyttäjä on vuorovaikutuksessa kuormituksesi kanssa.
RequestId	True	string (uuid)	Globaalisti yksilöivä tunnus, jonka avulla Fabric korreloi pyyntösi lokeihin. Anna tämä tunnus, kun ilmoitat ongelmasta.
Authorization	True	string	Kaksoistunnus-valtuutusotsikko, jonka avulla kuormitus voi vahvistaa pyynnön alkuperän, tarjota käyttäjäkontekstin ja kutsua muita palveluita. Tämä otsikko on seuraavassa muodossa: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.
x-ms-client-tenant-id	True	string (uuid)	Pyynnön tekevän asiakkaan vuokraajatunnus.

Pyynnön leipäteksti

Nimi	Tyyppi	Description
definition	ItemDefinition	Edustaa kohteen sisäistä määritelmää.

Vastaukset

Nimi	Tyyppi	Description
200 OK		Päivitys onnistui.
Other Status Codes	ErrorResponse	Virhetilanteissa kuormituksen tulisi palauttaa asianmukainen HTTP-virheen tilakoodi (4xx, 5xx), jossa on yksityiskohtaisia virhetietoja vastauksen tekstiosassa.

Esimerkit

Update item example

Mallipyyntö

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/OnUpdateItem

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

Mallivastaus

Tilakoodi:: 200

Määritelmät

Nimi	Description
ErrorExtendedInformation	Laajennetut virhetiedot.
ErrorResponse	Virhevastaus.
ErrorSource	Virheen lähde.
ItemDefinition	Edustaa kohteen sisäistä määritelmää.
ItemDefinitionPart	Edustaa tietoyksikkömääritelmän osaa.
NameValuePair	Nimi–arvo-pari.
OnUpdateItemRequest	Pyydä leipätekstiä etäkuormituksen kohteen määrityksen päivittämistä varten.

ErrorExtendedInformation

Kohde

Laajennetut virhetiedot.

Nimi	Tyyppi	Description
additionalParameters	NameValuePair[]	Luettelo virheen muista parametreista.
errorCode	string	Virhekoodi.
message	string	Virhesanoma.
messageParameters	string[]	Lokalisoidun sanoman muotoilun parametrien luettelo.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Virhekoodi.
isPermanent	boolean	Ilmaisee, onko virhe pysyvä vai voidaanko toimintoa yrittää uudelleen.
message	string	Virhesanoma.
messageParameters	string[]	Lokalisoidun sanoman muotoilun parametrien luettelo.
moreDetails	ErrorExtendedInformation[]	Luettelo virheiden lisätiedoista.
source	ErrorSource	Virheen lähde.

ErrorSource

Luettelointi

Virheen lähde.

Arvo	Description
System	Virhe oli peräisin järjestelmästä.
User	Virhe oli peräisin käyttäjän syötteestä.
External	Virhe oli peräisin ulkoisesta lähteestä.

ItemDefinition

Kohde

Edustaa kohteen sisäistä määritelmää.

Nimi	Tyyppi	Description
parts	ItemDefinitionPart[]	Määritysosat.

ItemDefinitionPart

Kohde

Edustaa tietoyksikkömääritelmän osaa.

Nimi	Tyyppi	Description
path	string	Osan polku (esimerkiksi .platform).
payload	string	Tiedot (sisäinen Base64-sisältö).
payloadType	string	Hyötykuormatyyppi (esimerkiksi 'InlineBase64').

NameValuePair

Kohde

Nimi–arvo-pari.

Nimi	Tyyppi	Description
name	string	Nimi.
value	string	Arvo.

OnUpdateItemRequest

Kohde

Pyydä leipätekstiä etäkuormituksen kohteen määrityksen päivittämistä varten.

Nimi	Tyyppi	Description
definition	ItemDefinition	Edustaa kohteen sisäistä määritelmää.