widgets
GET /api/widgets
Summary: List all widgets
List is always filtered by owner, unless you have permission for managing widgets AND set "show_all" parameter - then you'll see all widgets.
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| query | title |
string | no | |
| query | ordering |
string | no | Which field to use when ordering the results. |
| query | page |
integer | no | A page number within the paginated result set. |
| query | page_size |
integer | no | Number of results to return per page. |
| query | show_all |
boolean | no | Do not filter objects owned by current user |
| query | export |
boolean | no | Return exportable fields only |
Responses
-
200 —
-
Media type:
application/json
Type: PaginatedWidgetList
DELETE /api/widgets/{id}
Summary: Delete specified widget
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this widget. |
Responses
- 204 — No response body
GET /api/widgets/{id}
Summary: Get details for specified widget id
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this widget. |
| query | export |
boolean | no | Return exportable fields only |
Responses
-
200 —
-
Media type:
application/json
Type: Widget
PATCH /api/widgets/{id}
Summary: Update widget specific settings
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this widget. |
Request Body
- Media type:
application/json
Type: PatchedWidget
- Media type:
application/x-www-form-urlencoded
Type: PatchedWidget
- Media type:
multipart/form-data
Type: PatchedWidget
Responses
-
200 —
-
Media type:
application/json
Type: Widget
PUT /api/widgets/{id}
Summary: Replace specified widget
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this widget. |
Request Body
- Media type:
application/json
Type: Widget
- Media type:
application/x-www-form-urlencoded
Type: Widget
- Media type:
multipart/form-data
Type: Widget
Responses
-
200 —
-
Media type:
application/json
Type: Widget