PUT v1/Dashboards/GetDataSeriesWithFilter?gadgetId={gadgetId}&dashboardId={dashboardId}&isOnFilterChange={isOnFilterChange}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
gadgetId

integer

Required

dashboardId

integer

Default value is 0

isOnFilterChange

boolean

Default value is False

Body Parameters

Collection of FilterField
NameDescriptionTypeAdditional information
id

integer

None.

selection

Collection of string

None.

selectedItems

Collection of ItemBaseModel

None.

equalType

enmEqualType

None.

Request Formats

application/json, text/json, application/vnd.team.do+json

Sample:
[
  {
    "id": 1,
    "selection": [
      "sample string 1",
      "sample string 2"
    ],
    "selectedItems": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "equalType": 0
  },
  {
    "id": 1,
    "selection": [
      "sample string 1",
      "sample string 2"
    ],
    "selectedItems": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "equalType": 0
  }
]

text/html

Sample:
[{"id":1,"selection":["sample string 1","sample string 2"],"selectedItems":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"equalType":0},{"id":1,"selection":["sample string 1","sample string 2"],"selectedItems":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"equalType":0}]

Response Information

Resource Description

DataSeriesWithFilter
NameDescriptionTypeAdditional information
filterId

integer

None.

filterSelections

Collection of FilterField

None.

dataSeries

Collection of DataSeries

None.

totalOptions

TotalOptions

None.

gadgetId

integer

None.

gadgetName

string

None.

axisLabelsFieldId

integer

None.

Response Formats

application/json, text/json, application/vnd.team.do+json

Sample:
{
  "filterId": 1,
  "filterSelections": [
    {
      "id": 1,
      "selection": [
        "sample string 1",
        "sample string 2"
      ],
      "selectedItems": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ],
      "equalType": 0
    },
    {
      "id": 1,
      "selection": [
        "sample string 1",
        "sample string 2"
      ],
      "selectedItems": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ],
      "equalType": 0
    }
  ],
  "dataSeries": [
    {
      "name": "sample string 1",
      "data": null
    },
    {
      "name": "sample string 1",
      "data": null
    }
  ],
  "totalOptions": {
    "totalType": 0,
    "colsIdGroupBy": 1
  },
  "gadgetId": 2,
  "gadgetName": "sample string 3",
  "axisLabelsFieldId": 4
}

text/html

Sample:
{"filterId":1,"filterSelections":[{"id":1,"selection":["sample string 1","sample string 2"],"selectedItems":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"equalType":0},{"id":1,"selection":["sample string 1","sample string 2"],"selectedItems":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"equalType":0}],"dataSeries":[{"name":"sample string 1","data":null},{"name":"sample string 1","data":null}],"totalOptions":{"totalType":0,"colsIdGroupBy":1},"gadgetId":2,"gadgetName":"sample string 3","axisLabelsFieldId":4}