Line Chart

Description

The Line Chart type posts the specified AVEVA Insight data as a line chart.

Method

POST

Required Parameters

• ChartType
  Specifies the chart type. The value for this must be "LineChart"or "Line 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.

• 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.

• ScaleY
  Indicates whether to scale the Y axis to the actual values reported rather than the possible minimum and maximum values. Valid value are: True, False

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

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

• XAxisTicks
  Specifies the number of ticks on the X axis.

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

• YAxisTicks
  Specifies the number of ticks on the X axis.

• YAxisType
  Specifies how values are displayed on the Y axis: "multi", "single", or "stacked".

• ScooterVisible
  Indicates whether to show the chart scooter. Valid value are: True, False

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 Line chart",

"ChartType": "Line Chart",

"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"

}

]

}