Notebook.clear_preferred_figure¶
Clear the preferred figure to restore the normal graph (notebook:update).
Signature¶
clear_preferred_figure() -> Notebook
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
notebook_id |
path |
string |
yes | - |
Return shape¶
HTTP 200 — OK
Schema: NotebookSchema
| Field | Type | Required |
|---|---|---|
created_at |
string |
no |
description |
string |
yes |
id |
string |
yes |
preferred_figure_id |
string |
no |
primary_dataset_id |
string |
no |
project_id |
string |
yes |
slug |
string |
no |
slug_number |
integer |
no |
tags |
array<NotebookTagSchema> |
no |
title |
string |
yes |
trace_count |
integer |
no |
updated_at |
string |
no |
Permission¶
Required permission: notebook:update
HTTP¶
DELETE /api/notebooks/{id}/preferred-figure (clearNotebookPreferredFigure)
Usage¶
notebook.clear_preferred_figure()