GET v1/Dashboards/GetDataSeriesExample?fieldId={fieldId}&projectId={projectId}&forChartCreate={forChartCreate}&forNumberCreate={forNumberCreate}

Request Information

URI Parameters

Name	Type	Additional information
fieldId	integer	Required
projectId	integer	Default value is 0
forChartCreate	boolean	Default value is False
forNumberCreate	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

DataSeriesWithFilter

Name	Type	Additional 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}