Items - Get Notebook Definition
Returnerer den angitte offentlige definisjonen for notatblokken.
Denne API-en støtter langvarige operasjoner (LRO).
Når du får en offentlig definisjon av en notatblokk, er ikke følsomhetsetiketten en del av definisjonen.
Tillatelser
Innringeren må ha lese- og skrivetillatelser for notatblokken.
Nødvendige delegerte omfang
Notebook.ReadWrite.All eller Item.ReadWrite.All
Begrensninger
Hvis du vil hente definisjonen av et notatblokkelement som er beskyttet av en kryptert følsomhetsetikett, må innringeren ha tilstrekkelige bruksrettigheter til å fjerne etiketten, som konfigurert i Microsoft Purview.
Microsoft Entra-støttede identiteter
Denne API-en støtter Microsoft -identiteter oppført i denne delen.
| Identitet | Kundestøtte |
|---|---|
| Bruker | Ja |
| tjenestekontohaver og administrerte identiteter | Ja |
Grensesnitt
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}
URI-parametere
| Name | I | Obligatorisk | Type | Beskrivelse |
|---|---|---|---|---|
|
notebook
|
path | True |
string (uuid) |
Notatblokk-ID-en. |
|
workspace
|
path | True |
string (uuid) |
Arbeidsområde-ID-en. |
|
format
|
query |
string |
Formatet for den offentlige definisjonen for notatblokken. Støttet format: |
Svar
| Name | Type | Beskrivelse |
|---|---|---|
| 200 OK |
Forespørselen er fullført. |
|
| 202 Accepted |
Forespørselen er godtatt. Henting av definisjonen pågår. Overskrifter
|
|
| 429 Too Many Requests |
Grensen for tjenestesats ble overskredet. Serveren returnerer en Overskrifter Retry-After: integer |
|
| Other Status Codes |
Vanlige feilkoder:
|
Eksempler
|
Get a notebook definition in fabric |
| Get a notebook definition in ipynb format example |
Get a notebook definition in fabricGitSource format example
Eksempelforespørsel
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition
Eksempelsvar
{
"definition": {
"parts": [
{
"path": "notebook-content.py",
"payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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
Eksempelforespørsel
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb
Eksempelsvar
{
"definition": {
"parts": [
{
"path": "notebook-content.ipynb",
"payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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
Definisjoner
| Name | Beskrivelse |
|---|---|
|
Error |
En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil. |
|
Error |
Objektet for feilrelaterte ressursdetaljer. |
|
Error |
Feilsvaret. |
|
Error |
Feilsvardetaljene. |
|
Notebook |
Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om strukturen i notatblokkdefinisjonen. |
|
Notebook |
Notatblokkdefinisjonsdelobjekt. |
|
Notebook |
Svar på offentlig definisjon for notatblokken. |
|
Payload |
Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid. |
ErrorParameter
En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
| Name | Type | Beskrivelse |
|---|---|---|
| message |
string |
En lesbar beskrivelse av parameterens betydning. |
| name |
string |
Parameteridentifikatoren. |
| value |
string |
Parameterverdien. |
ErrorRelatedResource
Objektet for feilrelaterte ressursdetaljer.
| Name | Type | Beskrivelse |
|---|---|---|
| resourceId |
string |
Ressurs-ID-en som er involvert i feilen. |
| resourceType |
string |
Typen ressurs som er involvert i feilen. |
ErrorResponse
Feilsvaret.
| Name | Type | Beskrivelse |
|---|---|---|
| errorCode |
string |
En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne. |
| isRetriable |
boolean |
Når sann, kan forespørselen prøves på nytt.
|
| message |
string |
En menneskelig lesbar representasjon av feilen. |
| moreDetails |
Liste over flere feildetaljer. |
|
| parameters |
Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen. |
|
| relatedResource |
Feilrelaterte ressursdetaljer. |
|
| requestId |
string (uuid) |
ID for forespørselen som er knyttet til feilen. |
ErrorResponseDetails
Feilsvardetaljene.
| Name | Type | Beskrivelse |
|---|---|---|
| errorCode |
string |
En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne. |
| message |
string |
En menneskelig lesbar representasjon av feilen. |
| parameters |
Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen. |
|
| relatedResource |
Feilrelaterte ressursdetaljer. |
NotebookDefinition
Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om strukturen i notatblokkdefinisjonen.
| Name | Type | Beskrivelse |
|---|---|---|
| format |
string |
Formatet for notatblokkdefinisjonen. Støttet format: |
| parts |
En liste over definisjonsdeler. |
NotebookDefinitionPart
Notatblokkdefinisjonsdelobjekt.
| Name | Type | Beskrivelse |
|---|---|---|
| path |
string |
Notatblokkdelbanen. Støttede notatblokkinnholdsutvidelser: |
| payload |
string |
Nyttelasten for notatblokkdelen. |
| payloadType |
Nyttelasttypen. |
NotebookDefinitionResponse
Svar på offentlig definisjon for notatblokken.
| Name | Type | Beskrivelse |
|---|---|---|
| definition |
Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om strukturen i notatblokkdefinisjonen. |
PayloadType
Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.
| Verdi | Beskrivelse |
|---|---|
| InlineBase64 |
Innebygd grunntall 64. |