Item Lifecycle - Create Item

Servicio:

Workload Development

Versión de la API:

v1

Llamado por Microsoft Fabric para crear un nuevo elemento.
Tras la creación de elementos, Fabric realiza validaciones básicas, crea el elemento en un estado de aprovisionamiento y llama a esta API para notificar a la carga de trabajo. Se espera que la carga de trabajo realice validaciones necesarias, almacene los metadatos del elemento, asigne recursos necesarios y actualice la caché de metadatos del elemento de Fabric con las relaciones de elementos y ETag.

Esta API debe aceptar la autenticación SubjectAndApp.

Permisos

Microsoft Fabric comprueba los permisos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
itemId	path	True	string (uuid)	Identificador del elemento.
itemType	path	True	string	Tipo de elemento.
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
ActivityId	True	string	Un identificador único para correlacionar la solicitud con el sistema cuando un usuario interactúa con la carga de trabajo.
RequestId	True	string	Un identificador único global que ayuda a Fabric a correlacionar su solicitud con nuestros registros. Proporcione este identificador al notificar un problema.
Authorization	True	string	Encabezado de autorización de token dual que permite a la carga de trabajo validar el origen de la solicitud, proporcionar contexto de usuario y llamar a otros servicios. Este encabezado tiene el siguiente formato: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	Identificador de inquilino del cliente que realiza la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
displayName	True	string maxLength: 256	Nombre para mostrar del elemento. No se pueden superar los 256 caracteres.
creationPayload		object	Carga de creación específica para la carga de trabajo y el tipo de elemento. Pasado por el editor de elementos o como parámetro de api de automatización de Fabric.
description		string	Descripción del elemento.

Respuestas

Nombre	Tipo	Description
200 OK		Se ha creado correctamente.
Other Status Codes	ErrorResponse	Para las condiciones de error, la carga de trabajo debe devolver un código de estado de error HTTP adecuado (4xx, 5xx) con información detallada del error en el cuerpo de la respuesta.

Ejemplos

Create item example

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
CreateItemRequest	Cree contenido de solicitud de elemento.
ErrorExtendedInformation	Información de error extendida.
ErrorResponse	Respuesta de error.
ErrorSource	Origen del error.
NameValuePair	Par nombre-valor.

CreateItemRequest

Object

Cree contenido de solicitud de elemento.

Nombre	Tipo	Description
creationPayload	object	Carga de creación específica para la carga de trabajo y el tipo de elemento. Pasado por el editor de elementos o como parámetro de api de automatización de Fabric.
description	string	Descripción del elemento.
displayName	string maxLength: 256	Nombre para mostrar del elemento. No se pueden superar los 256 caracteres.

ErrorExtendedInformation

Object

Información de error extendida.

Nombre	Tipo	Description
additionalParameters	NameValuePair[]	Lista de parámetros adicionales específicos del error.
errorCode	string	Código de error.
message	string	Mensaje de error.
messageParameters	string[]	Lista de parámetros para dar formato a un mensaje localizado.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Código de error.
isPermanent	boolean	Indica si el error es permanente o se puede reintentar la operación.
message	string	Mensaje de error.
messageParameters	string[]	Lista de parámetros para dar formato a un mensaje localizado.
moreDetails	ErrorExtendedInformation[]	Una lista de detalles de error adicionales.
source	ErrorSource	Origen del error.

ErrorSource

Enumeración

Origen del error.

Valor	Description
System
User
External

NameValuePair

Object

Par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre.
value	string	Valor.