Items - Get Notebook Definition

Služba:

Notebook

Verze rozhraní API:

v1

Vrátí zadanou veřejnou definici poznámkového bloku.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Když získáte veřejnou definici poznámkového bloku, popisek citlivosti není součástí definice.

Povolení

Volající musí mít pro poznámkový blok oprávnění ke čtení a zápisu .

Požadované delegovaná rozsahy

Notebook.ReadWrite.All nebo Item.ReadWrite.All

Omezení

Toto rozhraní API je blokované pro poznámkový blok se šifrovaným popiskem citlivosti.

Podporované identity v Microsoft Entra

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

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Ano

Rozhraní

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition

S volitelnými parametry:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
notebookId	path	True	string (uuid)	ID poznámkového bloku.
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.
format	query		string	Formát veřejné definice poznámkového bloku Podporovaný formát: ipynb a fabricGitSource. Pokud není k dispozici žádný formát, fabricGitSource použije se.

Odpovědi

Name	Typ	Description
200 OK	NotebookDefinitionResponse	Žádost byla úspěšně dokončena.
202 Accepted		Žádost byla přijata. Probíhá načítání definice. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
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: OperationNotSupportedForItem – Operace není podporována pro požadovanou položku.

Příklady

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Ukázkový požadavek

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Ukázková odpověď

Stavový kód:

200

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Stavový kód:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

Ukázkový požadavek

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

Ukázková odpověď

Stavový kód:

200

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Stavový kód:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
NotebookDefinition	Objekt veřejné definice poznámkového bloku Další podrobnosti o struktuře definice poznámkového bloku najdete v tomto článku .
NotebookDefinitionPart	Objekt části definice poznámkového bloku
NotebookDefinitionResponse	Odpověď na veřejnou definici poznámkového bloku
PayloadType	Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

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 (uuid)	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

NotebookDefinition

Objekt

Objekt veřejné definice poznámkového bloku Další podrobnosti o struktuře definice poznámkového bloku najdete v tomto článku .

Name	Typ	Description
format	string	Formát definice poznámkového bloku. Podporovaný formát: ipynb a fabricGitSource. Pokud není k dispozici žádný formát, fabricGitSource použije se.
parts	NotebookDefinitionPart[]	Seznam částí definice.

NotebookDefinitionPart

Objekt

Objekt části definice poznámkového bloku

Name	Typ	Description
path	string	Cesta k části poznámkového bloku. Podporované rozšíření obsahu poznámkového bloku: .ipynb pro ipynb formát; .py.scala, , .r, .sql pro fabricGitSource formát.
payload	string	Datová část poznámkového bloku.
payloadType	PayloadType	Typ datové části.

NotebookDefinitionResponse

Objekt

Odpověď na veřejnou definici poznámkového bloku

Name	Typ	Description
definition	NotebookDefinition	Objekt veřejné definice poznámkového bloku Další podrobnosti o struktuře definice poznámkového bloku najdete v tomto článku .

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota	Description
InlineBase64	Vložená základna 64.