Item Lifecycle - Create Item

Palvelu:

Workload Development

Ohjelmointirajapinnan versio:

v1

Microsoft Fabric soitti uuden kohteen luomista varten.
Kohteen luonnin yhteydessä Fabric suorittaa perustason vahvistukset, luo kohteen valmistelutilassa ja kutsuu tätä ohjelmointirajapintaa ilmoittamaan siitä kuormitukselle. Kuormituksen odotetaan suorittavan tarvittavat vahvistukset, tallentavan kohteen metatiedot, varaavan vaadittuja resursseja ja päivittävän Fabric-kohteen metatietovälimuistin kohdesuhteilla ja ETag-välimuistilla.

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

Käyttöoikeudet

Microsoft Fabric tarkistaa käyttöoikeudet.

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

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	Yksilöivä tunnus pyynnön korreloimiseen järjestelmän kanssa, kun käyttäjä on vuorovaikutuksessa kuormituksesi kanssa.
RequestId	True	string	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	Pyynnön tekevän asiakkaan vuokraajatunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
displayName	True	string maxLength: 256	Kohteen näyttönimi. Enintään 256 merkkiä.
creationPayload		object	Kuormitukseen ja kohdetyyppiin liittyvä luonnin hyötykuorma. Kohdeeditorin välittämä tai Fabric-automaation API-parametrina.
description		string	Kohteen kuvaus.

Vastaukset

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

Esimerkit

Create item example

Mallipyyntö

HTTP

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

{
  "displayName": "Forecast 1",
  "description": "The 1st forecast item",
  "creationPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

Mallivastaus

Tilakoodi:

200

Määritelmät

Nimi	Description
CreateItemRequest	Kohteen pyynnön sisällön luominen.
ErrorExtendedInformation	Laajennetut virhetiedot.
ErrorResponse	Virhevastaus.
ErrorSource	Virheen lähde.
NameValuePair	Nimi–arvo-pari.

CreateItemRequest

Object

Kohteen pyynnön sisällön luominen.

Nimi	Tyyppi	Description
creationPayload	object	Kuormitukseen ja kohdetyyppiin liittyvä luonnin hyötykuorma. Kohdeeditorin välittämä tai Fabric-automaation API-parametrina.
description	string	Kohteen kuvaus.
displayName	string maxLength: 256	Kohteen näyttönimi. Enintään 256 merkkiä.

ErrorExtendedInformation

Object

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

Object

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	Virhelähde.

ErrorSource

Luettelointi

Virheen lähde.

Arvo	Description
System
User
External

NameValuePair

Object

Nimi–arvo-pari.

Nimi	Tyyppi	Description
name	string	Nimi.
value	string	Arvo.