Items - Get Item

Service:

Core

API Version:

v1

Note

This API is in preview.

Returns properties of the specified item.

This API is supported for a number of item types, find the supported item types in Item management overview.

For retrieving additional type specific properties, refer to the get API reference page of the specific item type.

Permissions

The caller must have viewer or higher role on the workspace.

Required Delegated Scopes

For item APIs use these scope types:

• Generic scope: Item.Read.All or Item.ReadWrite.All
• Specific scope: itemType.Read.All or itemType.ReadWrite.All (for example: Notebook.ReadWrite.All)

for more information about scopes, see scopes article.

Interface

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

URI Parameters

Name	In	Required	Type	Description
itemId	path	True	string uuid	The item ID.
workspaceId	path	True	string uuid	The workspace ID.

Responses

Name	Type	Description
200 OK	Item	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found

Examples

Get an item example

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
Item	An item object.
ItemType	The type of the item. Additional item types may be added over time.

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	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	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	ErrorRelatedResource	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	ItemType	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.
Eventstream	string	An eventstream item.
KQLDataConnection	string	A KQL data connection.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	Lakehouse item.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredWarehouse	string	A MirroredWarehouse item.
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 item.