Items - Get Item

Služba:: Admin

Verze rozhraní API:: v1

Vrátí zadanou Fabric nebo položku PowerBI.

Note

Toto rozhraní API je součástí verze Preview a poskytuje se pouze pro účely vyhodnocení a vývoje. Může se změnit na základě zpětné vazby a nedoporučuje se pro produkční použití.

Permissions

Volající musí být správcem Fabric nebo se ověřovat pomocí instančního objektu.

Požadované delegovaná rozsahy

Tenant.Read.All nebo Tenant.ReadWrite.All

Limitations

Maximálně 200 požadavků za hodinu.

Microsoft Entra podporované identity

Toto rozhraní API podporuje Microsoft identity uvedené v této části.

Identity	Support
User	Yes
Hlavní služba a Spravované identity	Yes

Interface

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
itemId	path	True	string (uuid)	ID položky
workspaceId	path	True	string (uuid)	ID pracovního prostoru.
type	query		string	Typ položky. Při dotazování na následující typy je tento parametr povinný: Zpráva Dashboard SemanticModel App Dataflow

Název

Vyžadováno

Typ

Description

itemId

path

True

string (uuid)

ID položky

workspaceId

path

True

string (uuid)

ID pracovního prostoru.

type

query

string

Typ položky. Při dotazování na následující typy je tento parametr povinný:

Zpráva
Dashboard
SemanticModel
App
Dataflow

Odpovědi

Název Typ Description

200 OK

Název	Typ	Description
200 OK	Item	OK
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující `Retry-After` , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: ItemNotFound – ID položky neexistuje. InvalidItemType – Typ položky není platný.

Item

429 Too Many Requests

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Běžné kódy chyb:

ItemNotFound – ID položky neexistuje.
InvalidItemType – Typ položky není platný.

Příklady

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
    }
  },
  "defaultIdentity": {
    "id": "ff3c8689-591c-4298-a228-4ffcc77cb661",
    "displayName": "Caleb Foster",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "caleb@example.com"
    }
  }
}

Get item details by ID example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
    }
  }
}

Definice

Název	Description
EntireTenantPrincipal	Představuje objekt zabezpečení tenanta.
ErrorParameter	Strukturovaný parametr poskytující další strojově čitelný kontext chyby.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
GroupDetails	Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení `Group`.
GroupPrincipal	Představuje skupinu zabezpečení.
GroupType	Typ skupiny. V průběhu času je možné přidat další typy skupin.
Item	Podrobnosti o položce
ItemState	Stav položky. Další stavy položek mohou být přidány v průběhu času.
ItemTag	Představuje značku použitou u položky.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.
PrincipalType	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
ServicePrincipalDetails	Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení `ServicePrincipal`.
ServicePrincipalPrincipal	Představuje Microsoft Entra instanční objekt.
ServicePrincipalProfileDetails	Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Představuje profil instančního objektu.
UserDetails	Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení `User`.
UserPrincipal	Představuje Microsoft Entra objekt zabezpečení uživatele.

EntireTenantPrincipal

Objekt

Představuje objekt zabezpečení tenanta.

Název	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
type	string: EntireTenant	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ErrorParameter

Objekt

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

Název	Typ	Description
message	string	Popis významu parametru čitelný člověkem.
name	string	Identifikátor parametru.
value	string	Hodnota parametru.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Název	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Název	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky `Retry-After` odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
parameters	ErrorParameter[]	Strukturované parametry poskytují další strojově čitelný kontext chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Název	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
parameters	ErrorParameter[]	Strukturované parametry poskytují další strojově čitelný kontext chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

GroupDetails

Objekt

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.

Název	Typ	Description
groupType	GroupType	Typ skupiny. V průběhu času je možné přidat další typy skupin.

GroupPrincipal

Objekt

Představuje skupinu zabezpečení.

Název	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
groupDetails	GroupDetails	Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení `Group`.
id	string (uuid)	ID objektu zabezpečení.
type	string: Group	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

GroupType

Výčet

Typ skupiny. V průběhu času je možné přidat další typy skupin.

Hodnota	Description
Unknown	Typ hlavní skupiny je neznámý.
SecurityGroup	Objekt zabezpečení je skupina zabezpečení.
DistributionList	Objekt zabezpečení je distribuční seznam.

Item

Objekt

Podrobnosti o položce

Název	Typ	Description
capacityId	string (uuid)	ID kapacity pracovního prostoru.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Vlastník položky.
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Výchozí identita položky
description	string	Podrobnosti o položce, včetně typu položky a využití položek
folderId	string (uuid)	ID složky položky.
id	string (uuid)	ID položky.
lastUpdatedDate	string (date-time)	Datum a čas poslední aktualizace.
name	string	Název položky.
state	ItemState	Stav položky.
tags	ItemTag[]	Seznam použitých značek
type	ItemType	Typ položky. Obsahuje hodnoty, jako jsou Synapse, Notebook, Kqldatabase a SynapseWorkbook.
workspaceId	string (uuid)	ID položky pracovního prostoru.

ItemState

Výčet

Stav položky. Další stavy položek mohou být přidány v průběhu času.

Hodnota	Description
Active	Aktivní položka.

ItemTag

Objekt

Představuje značku použitou u položky.

Název	Typ	Description
displayName	string	Název značky.
id	string (uuid)	ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota	Description
Dashboard	Řídicí panel PowerBI
Report	Sestava PowerBI
SemanticModel	Sémantický model PowerBI
PaginatedReport	Stránkovaná sestava PowerBI
Datamart	Datový diagram PowerBI
Lakehouse	Jezero.
Eventhouse	Eventhouse.
Environment	Prostředí.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
KQLDashboard	Řídicí panel KQL.
DataPipeline	Datový kanál.
Notebook	Poznámkový blok.
SparkJobDefinition	Definice úlohy Sparku.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
Warehouse	Sklad.
Eventstream	Eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrcadlený sklad.
MirroredDatabase	Zrcadlené databáze.
Reflex	A Reflex.
GraphQLApi	Rozhraní API pro položku GraphQL
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáze SQLDatabase.
CopyJob	Úloha kopírování.
VariableLibrary	ProměnnáLibrary.
Dataflow	Tok dat.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímek skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog	Zrcadlený katalog Azure Databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkce uživatelských dat.
GraphModel	A GraphModel.
GraphQuerySet	Sada dotazů grafu.
SnowflakeDatabase	Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Databáze Cosmos DB.
Ontology	Ontologie.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	ZrcadlenýCatalog.
PolicySet	A PolicySet.
AppBackend	An AppBackend.
OrgApp	Aplikace organizace.
OrgAppAudience	Cílová skupina aplikace organizace.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Položka úložiště založené na OneLake pro Azure Databricks.
Plan	Plán.

PrincipalType

Výčet

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

Hodnota	Description
User	Objekt zabezpečení je Microsoft Entra objekt zabezpečení uživatele.
ServicePrincipal	Instanční objekt je Microsoft Entra instanční objekt.
Group	Objekt zabezpečení je skupina zabezpečení.
ServicePrincipalProfile	Instanční objekt je profil instančního objektu.
EntireTenant	Objekt zabezpečení představuje všechny uživatele tenanta.

ServicePrincipalDetails

Objekt

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.

Název	Typ	Description
aadAppId	string (uuid)	Instanční objekt Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Představuje Microsoft Entra instanční objekt.

Název	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
servicePrincipalDetails	ServicePrincipalDetails	Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení `ServicePrincipal`.
type	string: ServicePrincipal	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ServicePrincipalProfileDetails

Objekt

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.

Název	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Nadřazený objekt profilu instančního objektu.

ServicePrincipalProfilePrincipal

Objekt

Představuje profil instančního objektu.

Název	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

UserDetails

Objekt

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

Název	Typ	Description
userPrincipalName	string	Hlavní název uživatele.

UserPrincipal

Objekt

Představuje Microsoft Entra objekt zabezpečení uživatele.

Název	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení.
id	string (uuid)	ID objektu zabezpečení.
type	string: User	Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
userDetails	UserDetails	Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení `User`.