Delen via

Items - Get Item

  • Referentie
Service:
Admin
API-versie:
v1

Notitie

Deze API is in preview.

Retourneert het opgegeven Fabric- of PowerBI-item.

Machtigingen

De aanroeper moet een Fabric-beheerder zijn of verifiëren met behulp van een service-principal.

Vereiste gedelegeerde bereiken

Tenant.Read.All of Tenant.ReadWrite.All

Beperkingen

Maximaal 200 aanvragen per uur.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit Steunen
Gebruiker Ja
service-principal en beheerde identiteiten Ja

Interface

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

URI-parameters

Name In Vereist Type Description
itemId
 path True

string

uuid

De item-id
workspaceId
 path True

string

uuid

De werkruimte-id.
type
 query

string

Het type item. Bij het uitvoeren van query's op de volgende typen is deze parameter vereist:

  • Rapport

  • Dashboard

  • SemanticModel

  • App

  • Gegevensstroom

Antwoorden

Name Type Description
200 OK

Item

OK
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • ItemNotFound - Item-id bestaat niet.

  • InvalidItemType - Itemtype is niet geldig.

Voorbeelden

Get item details by ID and type example
Get item details by ID example

Get item details by ID and type example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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"
    }
  }
}

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.
GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
Item

Itemdetails.
ItemState

De itemstatus. Er kunnen in de loop van de tijd extra itemstatussen worden toegevoegd.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
Principal

Vertegenwoordigt een identiteit of een Microsoft Entra-groep.
PrincipalType

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.
ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.
UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name Type Description
groupType

GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupType

Inventarisatie

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde Description
DistributionList

Principal is een distributielijst.
SecurityGroup

Principal is een beveiligingsgroep.
Unknown

Het type Principal-groep is onbekend.

Item

Object

Itemdetails.

Name Type Description
capacityId

string

uuid

De capaciteits-id van de werkruimte.
creatorPrincipal

Principal

De eigenaar van het item.
description

string

Itemdetails, waaronder itemtype en itemgebruik.
id

string

uuid

De item-id.
lastUpdatedDate

string

date-time

De laatst bijgewerkte datum en tijd.
name

string

De itemnaam.
state

ItemState

De itemstatus.
type

ItemType

Het itemtype. Bevat waarden zoals Synapse, Notebook, Kqldatabase en SynapseWorkbook.
workspaceId

string

uuid

De werkruimte-id van het item.

ItemState

Inventarisatie

De itemstatus. Er kunnen in de loop van de tijd extra itemstatussen worden toegevoegd.

Waarde Description
Active

Een actief item.

ItemType

Inventarisatie

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
DataPipeline

Een gegevenspijplijn.
Datamart

PowerBI-datamart.
Environment

Een omgeving.
Eventhouse

Een eventhouse.
Eventstream

Een eventstream.
GraphQLApi

Een API voor GraphQL-item.
KQLDashboard

Een KQL-dashboard.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
Lakehouse

Een lakehouse.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
MirroredDatabase

Een gespiegelde database.
MirroredWarehouse

Een gespiegeld magazijn.
MountedDataFactory

Een MountedDataFactory.
Notebook

Een notitieblok.
PaginatedReport

Gepagineerd Power BI-rapport.
Reflex

Een reflex.
Report

PowerBI-rapport.
SQLDatabase

Een SQLDatabase.
SQLEndpoint

Een SQL-eindpunt.
SemanticModel

Semantisch Power BI-model.
SparkJobDefinition

Een Spark-taakdefinitie.
Warehouse

Een magazijn.

Principal

Object

Vertegenwoordigt een identiteit of een Microsoft Entra-groep.

Name Type Description
displayName

string

De weergavenaam van de principal.
groupDetails

GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.
id

string

uuid

De id van de principal.
servicePrincipalDetails

ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.
type

PrincipalType

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails

UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

PrincipalType

Inventarisatie

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde Description
Group

Principal is een beveiligingsgroep.
ServicePrincipal

Principal is een Microsoft Entra-service-principal.
ServicePrincipalProfile

Principal is een service-principalprofiel.
User

Principal is een Microsoft Entra-gebruikersprincipaal.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name Type Description
aadAppId

string

uuid

De Microsoft Entra AppId van de service-principal.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name Type Description
parentPrincipal

Principal

De bovenliggende principal van het service-principalprofiel.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name Type Description
userPrincipalName

string

De principal-naam van de gebruiker.