Items - Update Item

Servicio:

Core

Versión de la API:

v1

Actualiza las propiedades del elemento especificado.
Esta API se admite para varios tipos de elementos, busque los tipos de elementos admitidos e información sobre su estructura de definición en Información general de administración de elementos.

Permisos

El autor de la llamada debe tener rol de colaborador o superior en el área de trabajo.

Á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, vea: artículo ámbitos.

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

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

Parámetros de identificador URI

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

Cuerpo de la solicitud

Nombre	Tipo	Description
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.

Respuestas

Nombre	Tipo	Description
200 OK	Item	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado. InvalidRequest: solicitud de actualización no válida.

Ejemplos

Update an item example

Solicitud de ejemplo

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

Respuesta de muestra

status code:

200

{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
Item	Objeto item.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
UpdateItemRequest	Actualizar solicitud 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.

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.

UpdateItemRequest

Object

Actualizar solicitud de elemento.

Nombre	Tipo	Description
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.