Post /api/v3/dashboard/{dashboardId}/widget

Operation: AddWidgetV3 Permissions: DashboardAndMapsModule (View)

Summary

Add a widget to a dashboard
To add widgets to a dashboard you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you

Path and Query Parameters

Parameter Description Type Location
dashboardId dashboardRequired integer Path

Request Body Parameters

Content-Type: application/json

Type Reference: WidgetCreate

Parameter Description Type
widgetId Widget identifier Required integer
row Dashboard row Required integer
col Dashboard column Required integer
height Widget height Required integer
width Widget width Required integer
title Personal Widget title Must be between 0 and 600 characters Required string
userWidgetDescription Personal Widget description Must be between 0 and 600 characters string
filters Widget filters FilterEdit [Array]
   fieldId Data field ID for the filter Required integer
   operator Filter operator expressed as a string (e.g. “equals”) Required string
   value Filter value string

Request Body

{
  "widgetId": 1,
  "row": 1,
  "col": 1,
  "height": 1,
  "width": 1,
  "title": "string",
  "userWidgetDescription": "string",
  "filters": [
    {
      "fieldId": 1,
      "operator": "string",
      "value": "string"
    }
  ]
}

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: SpecificWidgetResponse

Parameter Description Type
specificWidgetId Specific widget identifier integer
title User Widget title string
widgetInfo Widget title string
description Widget description string
userWidgetDescription User Widget description string
row Dashboard row integer
col Dashboard column integer
height Widget height integer
width Widget width integer
filters Widget filters FilterResponse [Array]
   availableOperator The list of available operators Required (defined) array
   caption The caption of the filter Required (defined) string
   queryParameterName The Query parameter name Required (defined) string
   fieldId The field identifier Required (defined) integer
   dataFieldId The datafield identifier Required (defined) integer
   dataType DataTypeResponse
      dataTypeId Required (defined) integer
      dataTypeCode Required (defined) string
      dataTypeInfo Required (defined) string
   operator The operator Required (defined) string
   value The value of the filter Required (defined) string
   required Indicates if the filter is required boolean
   recommended Indicates if the filter is recommended Required (defined) boolean
   hidden Indicates if the filter is hidden Required (defined) boolean

Responses

HTTP 200

Body

Content Type: application/json
{
  "specificWidgetId": 1,
  "title": "string",
  "widgetInfo": "string",
  "description": "string",
  "userWidgetDescription": "string",
  "row": 1,
  "col": 1,
  "height": 1,
  "width": 1,
  "filters": [
    {
      "availableOperator": [
        "string"
      ],
      "caption": "string",
      "queryParameterName": "string",
      "fieldId": 1,
      "dataFieldId": 1,
      "dataType": {
        "dataTypeId": 1,
        "dataTypeCode": "string",
        "dataTypeInfo": "string"
      },
      "operator": "string",
      "value": "string",
      "required": false,
      "recommended": false,
      "hidden": false
    }
  ]
}