Items - Get Item

Reference

Service:: Admin

API Version:: v1

Note

This API is in preview.

Returns the specified Fabric or PowerBI item.

Permissions

The caller must be a Fabric administrator or authenticate using a service principal.

Required Delegated Scopes

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
itemId	path	True	string uuid	The item ID
workspaceId	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: Report Dashboard SemanticModel App Dataflow

Name

Required

Type

Description

itemId

path

True

string

uuid

The item ID

workspaceId

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:

Report
Dashboard
SemanticModel
App
Dataflow

Responses

Name	Type	Description
200 OK	Item	OK
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - Item ID doesn't exist. InvalidItemType - Item type isn't valid.

Name

Type

Description

200 OK

Item

Other Status Codes

ErrorResponse

Common error codes:

ItemNotFound - Item ID doesn't exist.
InvalidItemType - Item type isn't valid.

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48?type=Report

Sample response

Status code:: 200

{
  "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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48

Sample response

Status code:: 200

{
  "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
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GroupDetails	Group specific details. Applicable when the principal type is `Group`.
GroupType	The type of the group. Additional group types may be added over time.
Item	Item details.
ItemState	The item state. Additional item states may be added over time.
ItemType	The type of the item. Additional item types may be added over time.
Principal	Represents an identity or a Microsoft Entra group.
PrincipalType	The type of the principal. Additional principal types may be added over time.
ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is `ServicePrincipal`.
ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.
UserDetails	User principal specific details. Applicable when the principal type is `User`.

ErrorRelatedResource

Object

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

Object

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

Object

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.

GroupDetails

Object

Group specific details. Applicable when the principal type is Group.

Name	Type	Description
groupType	GroupType	The type of the group. Additional group types may be added over time.

GroupType

Enumeration

The type of the group. Additional group types may be added over time.

Value	Description
DistributionList	Principal is a distribution list.
SecurityGroup	Principal is a security group.
Unknown	Principal group type is unknown.

Item

Object

Item details.

Name	Type	Description
capacityId	string	The capacity ID of the workspace.
creatorPrincipal	Principal	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	ItemState	The item status.
type	ItemType	The item type. Includes values such as Synapse, Notebook, Kqldatabase and SynapseWorkbook.
workspaceId	string	The workspace ID of item.

ItemState

Enumeration

The item state. Additional item states may be added over time.

Value	Description
Active	An active item.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
Dashboard	PowerBI dashboard.
DataPipeline	A data pipeline.
Datamart	PowerBI datamart.
Environment	An environment.
Eventhouse	An eventhouse.
Eventstream	An eventstream.
GraphQLApi	An API for GraphQL item.
KQLDashboard	A KQL dashboard.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
Lakehouse	A lakehouse.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
MirroredDatabase	A mirrored database.
MirroredWarehouse	A mirrored warehouse.
MountedDataFactory	A MountedDataFactory.
Notebook	A notebook.
PaginatedReport	PowerBI paginated report.
Reflex	A Reflex.
Report	PowerBI report.
SQLEndpoint	An SQL endpoint.
SemanticModel	PowerBI semantic model.
SparkJobDefinition	A spark job definition.
Warehouse	A warehouse.

Principal

Object

Represents an identity or a Microsoft Entra group.

Name	Type	Description
displayName	string	The principal's display name.
groupDetails	GroupDetails	Group specific details. Applicable when the principal type is `Group`.
id	string	The principal's ID.
servicePrincipalDetails	ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.
type	PrincipalType	The type of the principal. Additional principal types may be added over time.
userDetails	UserDetails	User principal specific details. Applicable when the principal type is `User`.

PrincipalType

Enumeration

The type of the principal. Additional principal types may be added over time.

Value	Description
Group	Principal is a security group.
ServicePrincipal	Principal is a Microsoft Entra service principal.
ServicePrincipalProfile	Principal is a service principal profile.
User	Principal is a Microsoft Entra user principal.

ServicePrincipalDetails

Object

Service principal specific details. Applicable when the principal type is ServicePrincipal.

Name	Type	Description
aadAppId	string	The service principal's Microsoft Entra AppId.

ServicePrincipalProfileDetails

Object

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal	The service principal profile's parent principal.

UserDetails

Object

User principal specific details. Applicable when the principal type is User.

Name	Type	Description
userPrincipalName	string	The user principal name.

Freigeben über

Items - Get Item

Permissions

Required Delegated Scopes

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

Get item details by ID and type example

Sample request

Sample response

Get item details by ID example

Sample request

Sample response

Definitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

ItemState

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

Zusätzliche Ressourcen