FigureCollection.list¶
List all figures attached to a target, following offset pagination.
Signature¶
list(target: Dataset | Notebook) -> list[Figure]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
target |
Dataset \| Notebook |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
dataset_id |
query |
string |
no | - |
limit |
query |
integer |
no | 50 |
notebook_id |
query |
string |
no | - |
offset |
query |
integer |
no | 0 |
project_id |
query |
string |
yes | - |
Fields¶
| Field |
|---|
target |
Return shape¶
HTTP 200 — OK
array<FigureSchema>
Permission¶
Required permission: figure:read
HTTP¶
GET /api/figures/ (listFigures)
Usage¶
figure_collection.list(target)