Items - Get Notebook Definition

Service:: Notebook

API Version:: v1

Returns the specified notebook public definition.
This API supports long running operations (LRO).

When you get a notebook's public definition, the sensitivity label is not a part of the definition.

Permissions

The caller must have read and write permissions for the notebook.

Required Delegated Scopes

Notebook.ReadWrite.All or Item.ReadWrite.All

Limitations

To retrieve the definition of a notebook item protected by an encrypted sensitivity label, the caller must have sufficient usage rights to remove the label, as configured in Microsoft Purview.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
notebookId	path	True	string (uuid)	The notebook ID.
workspaceId	path	True	string (uuid)	The workspace ID.
format	query		string	The format of the notebook public definition. Supported format: `ipynb` and `fabricGitSource`. If no format is provided, `fabricGitSource` is used.

Responses

Name	Type	Description
200 OK	NotebookDefinitionResponse	Request completed successfully.
202 Accepted		Request accepted. Retrieving the definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Sample request

HTTP

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

Sample response

Status code:: 200

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

Status code:: 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

Sample request

HTTP

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

Sample response

Status code:: 200

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

Status code:: 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

Definitions

Name	Description
ErrorParameter	A structured parameter providing additional machine-readable context about an error.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
NotebookDefinition	Notebook public definition object. Refer to this article for more details on the structure of the Notebook definition.
NotebookDefinitionPart	Notebook definition part object.
NotebookDefinitionResponse	Notebook public definition response.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.

ErrorParameter

Object

A structured parameter providing additional machine-readable context about an error.

Name	Type	Description
message	string	A human-readable description of the parameter's meaning.
name	string	The parameter identifier.
value	string	The parameter value.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
isRetriable	boolean	When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
parameters	ErrorParameter[]	Structured parameters providing additional machine-readable context about the error.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
parameters	ErrorParameter[]	Structured parameters providing additional machine-readable context about the error.
relatedResource	ErrorRelatedResource	The error related resource details.

NotebookDefinition

Object

Notebook public definition object. Refer to this article for more details on the structure of the Notebook definition.

Name	Type	Description
format	string	The format of the Notebook definition. Supported format: `ipynb` and `fabricGitSource`. If no format is provided, `fabricGitSource` is used.
parts	NotebookDefinitionPart[]	A list of definition parts.

NotebookDefinitionPart

Object

Notebook definition part object.

Name	Type	Description
path	string	The notebook part path. Supported notebook content extensions: `.ipynb` for `ipynb` format; `.py`, `.scala`, `.r`, `.sql` for `fabricGitSource` format.
payload	string	The notebook part payload.
payloadType	PayloadType	The payload type.

NotebookDefinitionResponse

Object

Notebook public definition response.

Name	Type	Description
definition	NotebookDefinition	Notebook public definition object. Refer to this article for more details on the structure of the Notebook definition.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.