Delen via

Item Lifecycle - Create Item

Service:
Workload Development
API-versie:
v1

Aangeroepen door Microsoft Fabric voor het maken van een nieuw item.
Bij het maken van een item voert Fabric basisvalidaties uit, maakt u het item in een inrichtingsstatus en roept u deze API aan om de werkbelasting op de hoogte te stellen. De workload wordt verwacht vereiste validaties uit te voeren, de metagegevens van het item op te slaan, vereiste resources toe te wijzen en de cache voor metagegevens van fabric-items bij te werken met itemrelaties en ETag.

Deze API moet SubjectAndApp-verificatie accepteren.

Machtigingen

Machtigingen worden gecontroleerd door Microsoft Fabric.

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

URI-parameters

Name In Vereist Type Description
itemId
 path True

string (uuid)

De item-id.
itemType
 path True

string

Het itemtype.
workspaceId
 path True

string (uuid)

De werkruimte-id.

Aanvraagkoptekst

Name Vereist Type Description
ActivityId True

string

Een unieke id voor het correleren van de aanvraag met uw systeem wanneer een gebruiker interactie heeft met uw workload.
RequestId True

string

Een wereldwijd unieke id waarmee Fabric uw aanvraag correleert met onze logboeken. Geef deze id op bij het melden van een probleem.
Authorization True

string

Een dubbele tokenautorisatieheader waarmee de workload de oorsprong van de aanvraag kan valideren, gebruikerscontext kan bieden en andere services kan aanroepen. Deze header heeft de volgende indeling: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id True

string

De tenant-id van de client die de aanvraag indient.

Aanvraagbody

Name Vereist Type Description
displayName True

string

maxLength: 256

De weergavenaam van het item. Mag niet langer zijn dan 256 tekens.
creationPayload

object

Nettolading maken die specifiek is voor de workload en het itemtype. Doorgegeven door de itemeditor of als parameter voor de Fabric Automation-API.
description

string

De beschrijving van het item.

Antwoorden

Name Type Description
200 OK

Gemaakt.
Other Status Codes

ErrorResponse

Voor foutvoorwaarden moet de workload een geschikte HTTP-foutcode (4xx, 5xx) retourneren met gedetailleerde foutinformatie in de hoofdtekst van het antwoord.

Voorbeelden

Create item example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
200

Definities

Name Description
CreateItemRequest

Inhoud van itemaanvraag maken.
ErrorExtendedInformation

De uitgebreide foutinformatie.
ErrorResponse

Het foutbericht.
ErrorSource

De bron van de fout.
NameValuePair

Een naam-waardepaar.

CreateItemRequest

Object

Inhoud van itemaanvraag maken.

Name Type Description
creationPayload

object

Nettolading maken die specifiek is voor de workload en het itemtype. Doorgegeven door de itemeditor of als parameter voor de Fabric Automation-API.
description

string

De beschrijving van het item.
displayName

string

maxLength: 256

De weergavenaam van het item. Mag niet langer zijn dan 256 tekens.

ErrorExtendedInformation

Object

De uitgebreide foutinformatie.

Name Type Description
additionalParameters

NameValuePair[]

Een lijst met aanvullende parameters die specifiek zijn voor de fout.
errorCode

string

De foutcode.
message

string

Het foutbericht.
messageParameters

string[]

Een lijst met parameters voor het opmaken van een gelokaliseerd bericht.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

De foutcode.
isPermanent

boolean

Geeft aan of de fout permanent is of dat de bewerking opnieuw kan worden geprobeerd.
message

string

Het foutbericht.
messageParameters

string[]

Een lijst met parameters voor het opmaken van een gelokaliseerd bericht.
moreDetails

ErrorExtendedInformation[]

Een lijst met aanvullende foutdetails.
source

ErrorSource

De foutbron.

ErrorSource

Inventarisatie

De bron van de fout.

Waarde Description
System
User
External

NameValuePair

Object

Een naam-waardepaar.

Name Type Description
name

string

De naam.
value

string

De waarde.