Notebook
List notebooks¶
GET/api/v2/databases/{database}/schemas/{schema}/notebooks
List notebooks
Path Parameters¶
| Parameter | Description |
|---|---|
| database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
| schema | Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database. |
Query Parameters¶
| Parameter | Description |
|---|---|
| like string | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
| startsWith string | Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
| showLimit integer | Query parameter to limit the maximum number of rows returned by a command. |
| fromName string | Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
Response¶
| Code | Description |
|---|---|
| 200 | successful |
| 202 | Successfully accepted the request, but it is not completed yet. |
Create a notebook¶
POST/api/v2/databases/{database}/schemas/{schema}/notebooks
Create a notebook
Query Parameters¶
| Parameter | Description |
|---|---|
| createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
| Code | Description |
|---|---|
| 200 | Successful request. |
| 202 |
Fetch a notebook¶
Delete a notebook¶
DELETE/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}
Delete a notebook
Query Parameters¶
| Parameter | Description |
|---|---|
| ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
Execute a Notebook¶
Changes the name of the notebook to new name. The new identifier must be unique for the schema¶
POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename
Changes the name of the notebook to new name. The new identifier must be unique for the schema.
Query Parameters¶
| Parameter | Description |
|---|---|
| targetDatabase string | Database of the target resource. Defaults to the source's database |
| targetSchema string | Schema of the target resource. Defaults to the source's schema |
| targetName string | Name of the target resource. |
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
Adds a LIVE version to the notebook¶
POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version
Adds a LIVE version to the notebook
Query Parameters¶
| Parameter | Description |
|---|---|
| fromLast boolean | Sets the LIVE version to the LAST version of the notebook |
| comment string | Sets a comment for the notebook or version of the notebook |
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository¶
POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit
If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository
Query Parameters¶
| Parameter | Description |
|---|---|
| version string | live version of the alias |
| comment string | Sets a comment for the notebook or version of the notebook |
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |