Compartir a través de

Items - Create Item

  • Referencia
Servicio:
Core
Versión de la API:
v1

Crea un elemento en el área de trabajo especificada.
Esta API es compatible con varios tipos de elementos, busque los tipos de elementos admitidos en Información general sobre la administración de elementos. Puede usar obtener API de definición de elemento para obtener una definición de elemento.

Esta API admite operaciones de larga duración (LRO).

Permisos

El autor de la llamada debe tener rol de colaborador o superior.

Ámbitos delegados necesarios

Para las API de elementos, use estos tipos de ámbito:

  • Ámbito genérico: Item.ReadWrite.All
  • Ámbito específico: itemType. ReadWrite.All (por ejemplo: Notebook.ReadWrite.All)

para obtener más información sobre los ámbitos, consulte artículo sobre ámbitos.

Limitaciones

  • Para crear un elemento que no sea de PowerBI Fabric, el área de trabajo debe estar en una capacidad de Fabric compatible. Para obtener más información, consulte tipos de licencia de Microsoft Fabric.
  • Para crear un elemento de PowerBI, el usuario debe tener la licencia adecuada. Para obtener más información, consulte tipos de licencia de Microsoft Fabric.
  • Al crear un elemento, use creationPayload o definition, pero no use ambos al mismo tiempo.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Cuando se admite el tipo de elemento en la llamada. Compruebe la API correspondiente para el tipo de elemento al que llama, para ver si se admite la llamada. Por ejemplo, se admiten modelos semánticos.

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string

uuid

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
displayName True

string

Nombre para mostrar del elemento. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
type True

ItemType

Tipo de elemento.
creationPayload

object

Conjunto de propiedades usadas para crear el elemento. La página Crear elemento del tipo pertinente indica si se admite creationPayload y enumera las propiedades del elemento. Use creationPayload o definition. No puede usar ambos al mismo tiempo.
definition

ItemDefinition

Definición del elemento. La página Crear elemento del tipo pertinente indica si se admite la definición y detalla su estructura. Use definition o creationPayload. No puede usar ambos al mismo tiempo.
description

string

Descripción del elemento. La longitud máxima es de 256 caracteres.

Respuestas

Nombre Tipo Description
201 Created

Item

Creado correctamente
202 Accepted

Solicitud aceptada, aprovisionamiento de elementos en curso

Encabezados

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • InvalidItemType: el tipo de elemento no es válido.

  • ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento.

  • CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Create an item example

Solicitud de ejemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

Respuesta de muestra

status code:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definiciones

Nombre Description
CreateItemRequest

Cree una carga de solicitud de elemento.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
Item

Objeto item.
ItemDefinition

Objeto de definición de elemento.
ItemDefinitionPart

Objeto de elemento de definición de elemento.
ItemType

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
PayloadType

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

CreateItemRequest

Object

Cree una carga de solicitud de elemento.

Nombre Tipo Description
creationPayload

object

Conjunto de propiedades usadas para crear el elemento. La página Crear elemento del tipo pertinente indica si se admite creationPayload y enumera las propiedades del elemento. Use creationPayload o definition. No puede usar ambos al mismo tiempo.
definition

ItemDefinition

Definición del elemento. La página Crear elemento del tipo pertinente indica si se admite la definición y detalla su estructura. Use definition o creationPayload. No puede usar ambos al mismo tiempo.
description

string

Descripción del elemento. La longitud máxima es de 256 caracteres.
displayName

string

Nombre para mostrar del elemento. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
type

ItemType

Tipo de elemento.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

Item

Object

Objeto item.

Nombre Tipo Description
description

string

Descripción del elemento.
displayName

string

Nombre para mostrar del elemento.
id

string

uuid

Identificador del elemento.
type

ItemType

Tipo de elemento.
workspaceId

string

uuid

Identificador del área de trabajo.

ItemDefinition

Object

Objeto de definición de elemento.

Nombre Tipo Description
format

string

Formato de la definición de elemento.
parts

ItemDefinitionPart[]

Lista de elementos de definición.

ItemDefinitionPart

Object

Objeto de elemento de definición de elemento.

Nombre Tipo Description
path

string

Ruta de acceso del elemento.
payload

string

Carga útil del elemento.
payloadType

PayloadType

Tipo de carga.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor Description
Dashboard

Panel de PowerBI.
DataPipeline

Una canalización de datos.
Datamart

Datamart de PowerBI.
Environment

Un entorno.
Eventhouse

Un centro de eventos.
Eventstream

Una secuencia de eventos.
GraphQLApi

Una API para el elemento GraphQL.
KQLDashboard

Un panel de KQL.
KQLDatabase

Una base de datos KQL.
KQLQueryset

Un conjunto de consultas KQL.
Lakehouse

Una casa de lago.
MLExperiment

Un experimento de aprendizaje automático.
MLModel

Un modelo de aprendizaje automático.
MirroredDatabase

Una base de datos reflejada.
MirroredWarehouse

Un almacén reflejado.
MountedDataFactory

A MountedDataFactory.
Notebook

Un cuaderno.
PaginatedReport

Informe paginado de PowerBI.
Reflex

Un reflejo.
Report

Informe de PowerBI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Un punto de conexión de SQL.
SemanticModel

Modelo semántico de PowerBI.
SparkJobDefinition

Una definición de trabajo de Spark.
Warehouse

Un almacén.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor Description
InlineBase64

Base 64 insertada.