FigureCollection.get¶
Fetch a saved figure including its JSON and validation report.
Signature¶
get(figure_id: str) -> Figure
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
figure_id |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
figure_id |
path |
string |
yes | - |
Fields¶
| Field |
|---|
figure_id |
Return shape¶
HTTP 200 — OK
Schema: FigureSchema
| Field | Type | Required |
|---|---|---|
author |
string |
no |
config |
object |
no |
conversation_id |
string |
no |
created_at |
string |
yes |
dataset_id |
string |
no |
figure |
object |
yes |
frames |
array<object> |
no |
id |
string |
yes |
name |
string |
yes |
notebook_id |
string |
no |
original_upload_hash |
string |
no |
original_upload_id |
string |
no |
owner_id |
string |
no |
plotly_version |
string |
no |
point_count |
integer |
no |
producer |
string |
no |
project_id |
string |
yes |
revision |
integer |
no |
size_bytes |
integer |
no |
source |
string |
yes |
source_provenance |
object |
no |
spec |
object |
no |
support_report |
object |
no |
title |
string |
no |
updated_at |
string |
yes |
validation_reasons |
array<string> |
no |
validation_status |
string |
no |
Permission¶
Required permission: figure:read
HTTP¶
GET /api/figures/{figure_id}/ (getFigure)
Usage¶
figure_collection.get(figure_id)