Cumulative Sum Chart

Description

The Cumulative Sum Chart type posts the specified AVEVA Insight data as a cumulative sum chart (also called a rolling sum chart).

Method

POST

Required Parameters

• ChartType
  Specifies the chart type. The value for this must be "CumulativeSum". or "Cumulative Sum" (the space is ignored).

• Version
  Specifies the API version: "1.0" or "2.0".

• TimeRangeUTC
  Indicates the start and end of the time range in this format: "2015-09-12T10:13:39.257Z,2015-10-12T10:13:39.257Z".

• Tags.TagName
  For each tag, indicates the data source and tag name.

• Tags.Color
  For each tag, indicates which color to use for the tag's data. For example:: "#03A9F4".

• Tags.Source
  Specifies the data source name for the tag.

• NchToken
  (AVEVA Insight Chart API v1 only) Indicates the NCH token in this format: "xyz".

Optional Parameters

• ChartTitle
  Names your chart.

• LimitLineVisible
  Specifies whether to display the limit line. Valid values are: True, False

• LimitLineText
  Specifies the text to display for the limit line. For example: "Last Month's Average".

• LimitLinePosition
  Indicates where on the (vertical) Y-axis to place the limit line.

• LookBack
  Specifies the time frame to use in the comparison for the summary. For example, if you were reporting a week's worth of daily summaries, you might choose to "look back" three days. Thus, the first day's summary would include information from the three days that preceded the week being reported.

• TimeAggregate
  Specifies whether to summarize data into daily or hourly values. Valid values are: Day, Hour, 15minutes

• LegendVisible
  Indicates whether to show the chart legend. Valid value are: True, False

• XAxisLabel
  Indicates a label for the (horizontal) X axis.

• YAxisLabel
  Indicates a label for the (vertical) Y axis.

Success Response

Code: 200
OK

Error Response

Code: 400
Content: Invalid Token or Bad Request

or

Code: 500
Content: <description varies>

Example

{

"ChartTitle": "Template API Cumulative Sum chart",

"ChartType": "Cumulative Sum",

"Version": "1.0",

"TimeRangeUTC": "2015-10-12T13:46:28.000Z,2015-10-29T13:50:37.734Z",

"Tags": [

{

"TagName": "Weather.Batna_clouds_value ",

"Color": "#03A9F4"

},

{

"TagName": "Weather.Lagos_wind_speed_value ",

"Color": "#8BC34A"

}

]

}