Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Insight

Diagnostics Grid

  • Last UpdatedMay 19, 2023
  • 1 minute read

Description

The Diagnostic Grid type posts the specified AVEVA Insight data as a diagnostics grid.

Method

POST

Required Parameters

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

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 Diagnostic grid",

"ChartType": "Diagnostic Grid",

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

}

]

}

Related Links
TitleResults for “How to create a CRG?”Also Available in