Items - List Notebooks

Služba:

Notebook

Verze rozhraní API:

v1

Vrátí seznam poznámkových bloků ze zadaného pracovního prostoru.
Toto rozhraní API podporuje stránkování.

Dovolení

Volající musí mít roli prohlížeče nebo vyšší.

Požadované delegovaná rozsahy

Workspace.Read.All nebo Workspace.ReadWrite.All

Podporované identity Microsoft Entra

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

Identita	Podpora
Uživatel	Ano
instančního objektu a spravované identity	Ano

Rozhraní

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

S volitelnými parametry:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks?continuationToken={continuationToken}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string uuid	ID pracovního prostoru.
continuationToken	query		string	Token pro načtení další stránky výsledků.

Odpovědi

Name	Typ	Description
200 OK	Notebooks	Žádost byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Běžné kódy chyb: InvalidItemType – neplatný typ položky.

Příklady

List notebooks in workspace example

Ukázkový požadavek

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks

Ukázková odpověď

Stavový kód:

200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Notebook Name 1",
      "description": "A notebook description.",
      "type": "Notebook",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.
Notebook	Objekt poznámkového bloku.
Notebooks	Seznam poznámkových bloků

ErrorRelatedResource

Objekt

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

Name	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.

Name	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.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	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.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

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
DataPipeline	Datový kanál.
Datamart	Datový diagram PowerBI
Environment	Prostředí.
Eventhouse	Eventhouse.
Eventstream	Eventstream.
GraphQLApi	Rozhraní API pro položku GraphQL
KQLDashboard	Řídicí panel KQL.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
Lakehouse	Jezero.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
MirroredDatabase	Zrcadlené databáze.
MirroredWarehouse	Zrcadlený sklad.
MountedDataFactory	A MountedDataFactory.
Notebook	Poznámkový blok.
PaginatedReport	Stránkovaná sestava PowerBI
Reflex	A Reflex.
Report	Sestava PowerBI
SQLDatabase	Databáze SQLDatabase.
SQLEndpoint	Koncový bod SQL.
SemanticModel	Sémantický model PowerBI
SparkJobDefinition	Definice úlohy Sparku.
Warehouse	Sklad.

Notebook

Objekt

Objekt poznámkového bloku.

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný název položky.
id	string uuid	ID položky.
type	ItemType	Typ položky.
workspaceId	string uuid	ID pracovního prostoru.

Notebooks

Objekt

Seznam poznámkových bloků

Name	Typ	Description
continuationToken	string	Token pro další dávku sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
continuationUri	string	Identifikátor URI další dávky sady výsledků. Pokud neexistují žádné další záznamy, odebere se z odpovědi.
value	Notebook[]	Seznam poznámkových bloků