GetSnapshot

Calling this method retrieves the most recent measurement from a tag. The measurement is retrieved from the internal circular buffer in the DataDistributionModule.

Method Name:

GetSnapshot

Payload:

The direct command requires the id of the tag to return the latest measurement from. By default, only the most recent measurement is returned, but setting "includeHistory" to true makes it possible to return additional measurements limited by "historyLimitCount".

{
    "id": "someId",
    "includeHistory": true,
    "historyLimitCount": 100
}

This payload returns the most recent 100 measurements for the tag with id "someId".

Return value

The direct command returns an OperationResult that indicates either success or failure.

{
    "status": 200,
    "payload": {
        "status": "ok",
        "response": {
            "success": true,
            "snapShot": [
                {
                    "value": 7,
                    "id": "area.asset.output1",
                    "name": "",
                    "timeGenerated": "2023-05-10T12:19:07.6278739+00:00",
                    "startTimestamp": "2023-05-10T12:19:07.6278718+00:00",
                    "endTimestamp": null,
                    "quality": "Good",
                    "type": "Analog"
                }
            ]
        }
    }
}

The snapshot property contains either a single measurement, or a measurement list, depending on the includeHistory input property.