Partager via

Item Lifecycle - Create Item

Service:
Workload Development
Version d'API:
v1

Appelé par Microsoft Fabric pour la création d’un élément.
Lors de la création d’éléments, Fabric effectue des validations de base, crée l’élément dans un état d’approvisionnement et appelle cette API pour notifier la charge de travail. La charge de travail est censée effectuer des validations requises, stocker les métadonnées d’élément, allouer les ressources requises et mettre à jour le cache de métadonnées d’élément Fabric avec les relations d’élément et ETag.

Cette API doit accepter l’authentification SubjectAndApp.

Autorisations

Les autorisations sont vérifiées par Microsoft Fabric.

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

Paramètres URI

Nom Dans Obligatoire Type Description
itemId
 path True

string (uuid)

ID d’élément.
itemType
 path True

string

Type d’élément.
workspaceId
 path True

string (uuid)

ID de l’espace de travail.

En-tête de la demande

Nom Obligatoire Type Description
ActivityId True

string

ID unique pour la corrélation de la requête avec votre système lorsqu’un utilisateur interagit avec votre charge de travail.
RequestId True

string

ID global unique qui aide Fabric à mettre en corrélation votre demande avec nos journaux d’activité. Fournissez cet ID lors de la création d’un problème.
Authorization True

string

En-tête d’autorisation double jeton qui permet à la charge de travail de valider l’origine de la requête, de fournir un contexte utilisateur et d’appeler d’autres services. Cet en-tête a le format suivant : SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id True

string

ID de locataire du client effectuant la requête.

Corps de la demande

Nom Obligatoire Type Description
displayName True

string

maxLength: 256

Nom complet de l’élément. Impossible de dépasser 256 caractères.
creationPayload

object

Charge utile de création spécifique à la charge de travail et au type d’élément. Transmis par l’éditeur d’élément ou en tant que paramètre d’API Automation Fabric.
description

string

Description de l’élément.

Réponses

Nom Type Description
200 OK

Création réussie.
Other Status Codes

ErrorResponse

Pour les conditions d’erreur, la charge de travail doit retourner un code d’état d’erreur HTTP approprié (4xx, 5xx) avec des informations d’erreur détaillées dans le corps de la réponse.

Exemples

Create item example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Définitions

Nom Description
CreateItemRequest

Créez le contenu de la demande d’élément.
ErrorExtendedInformation

Informations d’erreur étendues.
ErrorResponse

Réponse d’erreur.
ErrorSource

Source de l’erreur.
NameValuePair

Paire nom-valeur.

CreateItemRequest

Object

Créez le contenu de la demande d’élément.

Nom Type Description
creationPayload

object

Charge utile de création spécifique à la charge de travail et au type d’élément. Transmis par l’éditeur d’élément ou en tant que paramètre d’API Automation Fabric.
description

string

Description de l’élément.
displayName

string

maxLength: 256

Nom complet de l’élément. Impossible de dépasser 256 caractères.

ErrorExtendedInformation

Object

Informations d’erreur étendues.

Nom Type Description
additionalParameters

NameValuePair[]

Liste des paramètres supplémentaires spécifiques à l’erreur.
errorCode

string

Code d’erreur.
message

string

Message d’erreur.
messageParameters

string[]

Liste des paramètres de mise en forme d’un message localisé.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Code d’erreur.
isPermanent

boolean

Indique si l’erreur est permanente ou si l’opération peut être retentée.
message

string

Message d’erreur.
messageParameters

string[]

Liste des paramètres de mise en forme d’un message localisé.
moreDetails

ErrorExtendedInformation[]

Liste des détails d’erreur supplémentaires.
source

ErrorSource

Source d’erreur.

ErrorSource

Énumération

Source de l’erreur.

Valeur Description
System
User
External

NameValuePair

Object

Paire nom-valeur.

Nom Type Description
name

string

Nom.
value

string

Valeur.