Notebook.add_equation¶
Add an equation to this notebook.
Signature¶
add_equation(name: str, expression: str, **kwargs: Any) -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
name |
str |
yes | - |
expression |
str |
yes | - |
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
notebook_id |
path |
string |
yes | - |
Fields¶
Schema: NotebookEquationCreateSchema
| Field |
|---|
name |
expression |
**kwargs |
Return shape¶
HTTP 201 — Created
Schema: NotebookEquationSchema
| Field | Type | Required |
|---|---|---|
created_at |
string |
no |
expression |
string |
yes |
id |
string |
yes |
name |
string |
yes |
order |
integer |
no |
result_unit |
string |
no |
source_equation_id |
string |
no |
updated_at |
string |
no |
variable_bindings |
object |
no |
Permission¶
Required permission: notebook:update
HTTP¶
POST /api/notebooks/{id}/equations/ (createNotebookEquation)
Usage¶
notebook.add_equation(name, expression)