Delete a Widget
Delete a dashboard widget.
URL: /dashboard-widget
Type: POST
Parameters
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (Eg: web, external) | String |
| Query | dashboardName** | Name of the dashboard. | String |
| Query | widgetName** | Name of the widget | String |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 200 | OK | Widget deleted successfully |
| 400 | Bad Request | Dashboard name/widget name is mandatory |
| 404 | Not Found | Dashboard not available for the given name |
| 403 | Forbidden | Permission not available for dashboard |
| 404 | Not Found | Widget not found |
Sample Request/Response
Use Case
Delete a widget named widget_1 from the dashboard dashboard_1.
Request URL
http://appviewxapi.com/avxapi/dashboard-widget?dashboardName=dashboard_1&widgetName=widget_1 &gwkey=f000ca01&gwsource=external
Request Payload
NA
Response
{
"response": "Widget deleted successfully.",
"message": "Widget deleted successfully.",
"appStatusCode": null,
"tags": null,
"headers": null
}