Summary Bar Chart

Description

The Summary Bar Chart type posts the specified AVEVA Insight data as a summary bar chart.

Method

POST

Required Parameters

• ChartType
  Specifies the chart type. The value for this must be "SummaryChart" or "Summary Chart" (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".

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

Optional Parameters

• ChartTitle
  Names your chart.

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

• ValueAggregate
  Specifies which retrieval mode to apply to the data. Valid values are: Average, Minimum, Maximum, Last, Integral, Meter

• TagsMetaData.EngUnit
  Specifies the engineering units used for the tag's values.

• TagsMetaData.EngUnitMin
  Specifies the minimum valid value for the tag.

• TagsMetaData.EngUnitMax
  Specifies the maximum valid value for the tag.

• TagsMetaData.TagType
  Specifies the type of tag. Valid values are: Analog, Discrete

• TagsMetaData.InterpolationType
  Specifies the interpolation type to apply. For example, "Linear".

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

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 Summary bar",

"ChartType": "Summary Chart",

"Version": "1.0",

"TimeRangeUTC": "2015-09-12T10:13:39.257Z,2015-10-12T10:13:39.257Z",

"Tags": [

{

"TagName": "Weather.Batna_clouds_value",

"Color": "#03A9F4"

},

{

"TagName": "Weather.Lagos_wind_speed_value",

"Color": "#8BC34A"

}

]

}