GET Gestalt/api/data/values?dsn[0]={dsn[0]}&dsn[1]={dsn[1]}&tag[0]={tag[0]}&tag[1]={tag[1]}&function={function}&start={start}&end={end}&points={points}&step={step}&annotations={annotations}

Performs a multi-data source data query.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dsn

The data source names.

Collection of string

Required

tag

The tags to query.

Collection of string

Required

function

The data function to use.

string

Required

start

The absolute or relative query start time.

string

Required

end

The absolute or relative query end time.

string

Required

points

The number of samples to retrieve.

integer

Default value is 0

step

The sample interval to use.

string

None.

annotations

Flags if annotations should be included in the response.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The content of a successful response will be a server data object for each tag in the request.

Collection of ServerData
NameDescriptionTypeAdditional information
tagId

Gets or sets the tag ID.

integer

None.

tagName

Gets or sets the tag name.

string

None.

dataSourceId

Gets or sets the data source ID for the tag.

integer

None.

dataSourceName

Gets or sets the data source name.

string

None.

tagFriendlyName

Gets or sets the friendly name for the tag.

string

None.

tagUnits

Gets or sets the tag units.

string

None.

isDigital

Gets or sets a flag specifying if the tag is a digital tag or not.

boolean

None.

states

Gets or sets the available states for the tag.

Collection of string

None.

tagData

Gets or sets the numerical data for the data query.

Collection of decimal number

None.

tagDataTime

Gets or sets the time stamps for the data query.

Collection of date

None.

tagStringValues

Gets or sets the digital state values for the data query.

Collection of string

None.

statusValues

Gets or sets the status values for the samples.

Collection of ValueStatus

None.

originalQuery

Gets or sets the components of the original data query. sd.originalQuery = new[] { request.startTime, request.endTime, request.formattedTimeStep, request.quantise };

Collection of string

None.

startTime

Gets or sets the query start time.

date

None.

endTime

Gets or sets the query end time.

date

None.

maximumDataValue

Gets or sets the minimum numerical value for the query.

decimal number

None.

maximumDataPosition

Index of the maximum value in the tagData array.

integer

None.

minimumDataValue

Gets or sets the maximum numerical value for the query.

decimal number

None.

minimumDataPosition

Index of the minimum value in the tagData array.

integer

None.

NOLUpper

Gets or sets the upper normal operating limit for the tag.

decimal number

None.

NOLLower

Gets or sets the lower normal operating limit for the tag.

decimal number

None.

SOLUpper

Gets or sets the upper safe operating limit for the tag.

decimal number

None.

SOLLower

Gets or sets the lower safe operating limit for the tag.

decimal number

None.

SDLUpper

Gets or sets the upper safe design limit for the tag.

decimal number

None.

SDLLower

Gets or sets the lower safe design limit for the tag.

decimal number

None.

status

Gets or sets the result status.

string

None.

interp

Gets or sets a flag specifying if the client should perform additional interpolation on the query results, or if they have been pre-interpolated.

boolean

None.

annotations

Gets or sets the annotations that are applicable to the tag data.

Collection of Annotation

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "tagId": 1,
    "tagName": "sample string 2",
    "dataSourceId": 3,
    "dataSourceName": "sample string 4",
    "tagFriendlyName": "sample string 5",
    "tagUnits": "sample string 6",
    "isDigital": true,
    "states": [
      "sample string 1",
      "sample string 2"
    ],
    "tagData": [
      1.1,
      2.1
    ],
    "tagDataTime": [
      "2021-07-24T12:16:01.1105361+00:00",
      "2021-07-24T12:16:01.1105361+00:00"
    ],
    "tagStringValues": [
      "sample string 1",
      "sample string 2"
    ],
    "statusValues": [
      0,
      0
    ],
    "originalQuery": [
      "sample string 1",
      "sample string 2"
    ],
    "startTime": "2021-07-24T12:16:01.1105361+00:00",
    "endTime": "2021-07-24T12:16:01.1105361+00:00",
    "maximumDataValue": 10.1,
    "maximumDataPosition": 11,
    "minimumDataValue": 12.1,
    "minimumDataPosition": 13,
    "NOLUpper": 14.1,
    "NOLLower": 15.1,
    "SOLUpper": 16.1,
    "SOLLower": 17.1,
    "SDLUpper": 18.1,
    "SDLLower": 19.1,
    "status": "sample string 20",
    "interp": true,
    "annotations": [
      {
        "Identifier": {
          "ID": "sample string 1",
          "TagName": "sample string 2",
          "UtcAnnotationTime": "2021-07-24T12:16:01.1105361+00:00"
        },
        "AnnotationType": 0,
        "ApplicationName": "sample string 1",
        "Description": "sample string 2",
        "Value": {},
        "UtcStartTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcEndTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcCreationTime": "2021-07-24T12:16:01.1105361+00:00",
        "Creator": "sample string 4",
        "UtcModifiedTime": "2021-07-24T12:16:01.1105361+00:00",
        "Modifier": "sample string 5",
        "IsReadOnly": true,
        "MoreInfo": "http://webapihelppage7.com"
      },
      {
        "Identifier": {
          "ID": "sample string 1",
          "TagName": "sample string 2",
          "UtcAnnotationTime": "2021-07-24T12:16:01.1105361+00:00"
        },
        "AnnotationType": 0,
        "ApplicationName": "sample string 1",
        "Description": "sample string 2",
        "Value": {},
        "UtcStartTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcEndTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcCreationTime": "2021-07-24T12:16:01.1105361+00:00",
        "Creator": "sample string 4",
        "UtcModifiedTime": "2021-07-24T12:16:01.1105361+00:00",
        "Modifier": "sample string 5",
        "IsReadOnly": true,
        "MoreInfo": "http://webapihelppage7.com"
      }
    ]
  },
  {
    "tagId": 1,
    "tagName": "sample string 2",
    "dataSourceId": 3,
    "dataSourceName": "sample string 4",
    "tagFriendlyName": "sample string 5",
    "tagUnits": "sample string 6",
    "isDigital": true,
    "states": [
      "sample string 1",
      "sample string 2"
    ],
    "tagData": [
      1.1,
      2.1
    ],
    "tagDataTime": [
      "2021-07-24T12:16:01.1105361+00:00",
      "2021-07-24T12:16:01.1105361+00:00"
    ],
    "tagStringValues": [
      "sample string 1",
      "sample string 2"
    ],
    "statusValues": [
      0,
      0
    ],
    "originalQuery": [
      "sample string 1",
      "sample string 2"
    ],
    "startTime": "2021-07-24T12:16:01.1105361+00:00",
    "endTime": "2021-07-24T12:16:01.1105361+00:00",
    "maximumDataValue": 10.1,
    "maximumDataPosition": 11,
    "minimumDataValue": 12.1,
    "minimumDataPosition": 13,
    "NOLUpper": 14.1,
    "NOLLower": 15.1,
    "SOLUpper": 16.1,
    "SOLLower": 17.1,
    "SDLUpper": 18.1,
    "SDLLower": 19.1,
    "status": "sample string 20",
    "interp": true,
    "annotations": [
      {
        "Identifier": {
          "ID": "sample string 1",
          "TagName": "sample string 2",
          "UtcAnnotationTime": "2021-07-24T12:16:01.1105361+00:00"
        },
        "AnnotationType": 0,
        "ApplicationName": "sample string 1",
        "Description": "sample string 2",
        "Value": {},
        "UtcStartTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcEndTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcCreationTime": "2021-07-24T12:16:01.1105361+00:00",
        "Creator": "sample string 4",
        "UtcModifiedTime": "2021-07-24T12:16:01.1105361+00:00",
        "Modifier": "sample string 5",
        "IsReadOnly": true,
        "MoreInfo": "http://webapihelppage7.com"
      },
      {
        "Identifier": {
          "ID": "sample string 1",
          "TagName": "sample string 2",
          "UtcAnnotationTime": "2021-07-24T12:16:01.1105361+00:00"
        },
        "AnnotationType": 0,
        "ApplicationName": "sample string 1",
        "Description": "sample string 2",
        "Value": {},
        "UtcStartTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcEndTime": "2021-07-24T12:16:01.1105361+00:00",
        "UtcCreationTime": "2021-07-24T12:16:01.1105361+00:00",
        "Creator": "sample string 4",
        "UtcModifiedTime": "2021-07-24T12:16:01.1105361+00:00",
        "Modifier": "sample string 5",
        "IsReadOnly": true,
        "MoreInfo": "http://webapihelppage7.com"
      }
    ]
  }
]