Items - Get Item
Note
This API is in preview.
Returns the specified Fabric or PowerBI item.
Permissions
The caller must have administrator rights (such as Office 365 Global administrator or Fabric administrator) or authenticate using a service principal.
Required Delegated Scopes
Tenant.Read.All or Tenant.ReadWrite.All
Limitations
Maximum 200 requests per hour.
Interface
GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}
GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}?type={type}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
item
|
path | True |
string uuid |
The item ID |
workspace
|
path | True |
string uuid |
The workspace ID. |
type
|
query |
string |
The type of the item. When querying for the following types, this parameter is required:
|
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Common error codes:
|
Examples
Get item details by ID and type example |
Get item details by ID example |
Get item details by ID and type example
Sample request
GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48?type=Report
Sample response
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"type": "Report",
"name": "Test",
"description": "Test Jacob's Report,",
"state": "Active",
"lastUpdatedDate": "2022-04-29T17:47:29.98673",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "Jacob@example.com"
}
}
}
Get item details by ID example
Sample request
GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48
Sample response
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"type": "Kusto",
"name": "Test",
"description": "Test Jacob's notebook.",
"state": "Active",
"lastUpdatedDate": "2022-04-29T17:47:29.98673",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "Jacob@example.com"
}
}
}
Definitions
Name | Description |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Group |
Group specific details. Applicable when the principal type is |
Group |
The type of the group. Additional group types may be added over time. |
Item |
Item details. |
Item |
The item state. Additional item states may be added over time. |
Item |
The type of the item. Additional item types may be added over time. |
Principal | |
Principal |
The type of the principal. Additional principal types may be added over time. |
Service |
Service principal specific details. Applicable when the principal type is |
Service |
Service principal profile details. Applicable when the principal type is |
User |
User principal specific details. Applicable when the principal type is |
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. |
GroupDetails
Group specific details. Applicable when the principal type is Group
.
Name | Type | Description |
---|---|---|
groupType |
The type of the group. Additional group types may be added over time. |
GroupType
The type of the group. Additional group types may be added over time.
Name | Type | Description |
---|---|---|
DistributionList |
string |
Principal is a distribution list. |
SecurityGroup |
string |
Principal is a security group. |
Unknown |
string |
Principal group type is unknown. |
Item
Item details.
Name | Type | Description |
---|---|---|
capacityId |
string |
The capacity ID of the workspace. |
creatorPrincipal |
The item's owner. |
|
description |
string |
Item details including item type and item usage. |
id |
string |
The item ID. |
lastUpdatedDate |
string |
The last updated date and time. |
name |
string |
The item name. |
state |
The item status. |
|
type |
The item type. Includes values such as Synapse, Notebook, Kqldatabase and SynapseWorkbook. |
|
workspaceId |
string |
The workspace ID of item. |
ItemState
The item state. Additional item states may be added over time.
Name | Type | Description |
---|---|---|
Active |
string |
An active item. |
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. |
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. |
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. |
Principal
Name | Type | Description |
---|---|---|
displayName |
string |
The principal's display name. |
groupDetails |
Group specific details. Applicable when the principal type is |
|
id |
string |
The principal's ID. |
servicePrincipalDetails |
Service principal specific details. Applicable when the principal type is |
|
servicePrincipalProfileDetails |
Service principal profile details. Applicable when the principal type is |
|
type |
The type of the principal. Additional principal types may be added over time. |
|
userDetails |
User principal specific details. Applicable when the principal type is |
PrincipalType
The type of the principal. Additional principal types may be added over time.
Name | Type | Description |
---|---|---|
Group |
string |
Principal is a security group. |
ServicePrincipal |
string |
Principal is a Microsoft Entra service principal. |
ServicePrincipalProfile |
string |
Principal is a service principal profile. |
User |
string |
Principal is a Microsoft Entra user principal. |
ServicePrincipalDetails
Service principal specific details. Applicable when the principal type is ServicePrincipal
.
Name | Type | Description |
---|---|---|
aadAppId |
string |
The service principal's Microsoft Entra AppId. |
ServicePrincipalProfileDetails
Service principal profile details. Applicable when the principal type is ServicePrincipalProfile
.
Name | Type | Description |
---|---|---|
parentPrincipal |
The service principal profile's parent principal. |
UserDetails
User principal specific details. Applicable when the principal type is User
.
Name | Type | Description |
---|---|---|
userPrincipalName |
string |
The user principal name. |