Items - Update Item
Updates the properties of the specified item.
This API is supported for a number of item types, find the supported item types and information about their definition structure in Item management overview.
Permissions
The caller must have contributor or higher role on the workspace.
Required Delegated Scopes
For item APIs use these scope types:
- Generic scope: Item.ReadWrite.All
- Specific scope: itemType.ReadWrite.All (for example: Notebook.ReadWrite.All)
for more information about scopes, see: scopes article.
Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |
Managed identities | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |
Interface
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
item
|
path | True |
string uuid |
The item ID. |
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Type | Description |
---|---|---|
description |
string |
The item description. Maximum length is 256 characters. |
displayName |
string |
The item display name. The display name must follow naming rules according to item type. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Examples
Update an item example
Sample request
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"
}
Sample response
{
"displayName": "Item's New name",
"description": "Item's New description",
"type": "Lakehouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Definitions
Name | Description |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Item |
An item object. |
Item |
The type of the item. Additional item types may be added over time. |
Update |
Update item request. |
ErrorRelatedResource
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |
Item
An item object.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
id |
string |
The item ID. |
type |
The item type. |
|
workspaceId |
string |
The workspace ID. |
ItemType
The type of the item. Additional item types may be added over time.
Name | Type | Description |
---|---|---|
Dashboard |
string |
PowerBI dashboard. |
DataPipeline |
string |
A data pipeline. |
Datamart |
string |
PowerBI datamart. |
Environment |
string |
An environment. |
Eventhouse |
string |
An eventhouse. |
Eventstream |
string |
An eventstream. |
KQLDashboard |
string |
A KQL dashboard. |
KQLDatabase |
string |
A KQL database. |
KQLQueryset |
string |
A KQL queryset. |
Lakehouse |
string |
A lakehouse. |
MLExperiment |
string |
A machine learning experiment. |
MLModel |
string |
A machine learning model. |
MirroredDatabase |
string |
A mirrored database. |
MirroredWarehouse |
string |
A mirrored warehouse. |
Notebook |
string |
A notebook. |
PaginatedReport |
string |
PowerBI paginated report. |
Report |
string |
PowerBI report. |
SQLEndpoint |
string |
An SQL endpoint. |
SemanticModel |
string |
PowerBI semantic model. |
SparkJobDefinition |
string |
A spark job definition. |
Warehouse |
string |
A warehouse. |
UpdateItemRequest
Update item request.
Name | Type | Description |
---|---|---|
description |
string |
The item description. Maximum length is 256 characters. |
displayName |
string |
The item display name. The display name must follow naming rules according to item type. |