Canvases
Endpoints related to Canvases.
| Method | Endpoint | Path |
|---|---|---|
DELETE | Delete canvases | /api/v1/canvas/ |
GET | Get canvas | /api/v1/canvas/ |
POST | Create a canvas | /api/v1/canvas/ |
GET | Get canvas info | /api/v1/canvas/_info |
GET | Get a canvas' definition | /api/v1/canvas/{id_or_uuid}/definition |
PATCH | Apply operations to a canvas' definition | /api/v1/canvas/{id_or_uuid}/definition |
GET | Get a canvas' definition changes since a revision | /api/v1/canvas/{id_or_uuid}/definition/changes |
POST | Start a private draft of a canvas | /api/v1/canvas/{id_or_uuid}/draft |
POST | Get a placement's data | /api/v1/canvas/{id_or_uuid}/placement/{placement_id}/data |
DELETE | Delete a canvas | /api/v1/canvas/{pk} |
GET | Get canvas by pk | /api/v1/canvas/{pk} |
PUT | Update a canvas' title, description and sharing | /api/v1/canvas/{pk} |
DELETE | Delete a canvas draft | /api/v1/canvas/draft |
GET | Get a canvas draft | /api/v1/canvas/draft |
PATCH | Apply operations to a canvas draft | /api/v1/canvas/draft |
POST | Commit a canvas draft | /api/v1/canvas/draft/commit |
GET | Get related fields data (canvas-related-column-name) | /api/v1/canvas/related/{column_name} |
GET | Get the canvas definition schema and widget behavior | /api/v1/canvas/schema |