FigureCollection.delete¶
Soft-delete a figure and clear its preferred-view pointers.
Signature¶
delete(figure_id: str) -> None
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 204 — No Content
Permission¶
Required permission: figure:delete
HTTP¶
DELETE /api/figures/{figure_id}/ (deleteFigure)
Usage¶
figure_collection.delete(figure_id)