Data Fabric IoT Time Series Query API

API change history

Query API for time series data

Returns n latest data points for given data channels

Try it

Request

Request URL

https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest

Request headers

x-requestidentifier (optional)

string

Trace id, optional, useful when requesting support for abnormal behavior of requests.
Content-Type (optional)

string

Media type of the body sent to the API.
Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.
Authorization

string

OAuth 2.0 access token obtained from B2C PROD OAuth - v2 endpoint. Supported grant types: Authorization code.

{
  "assetIds": [
    "string"
  ],
  "dataChannelIds": [
    "string"
  ],
  "typeOption": "Data",
  "dimensions": [
    "string"
  ],
  "latestNValues": 0,
  "dataChannelIdType": "DataChannelUuid"
}

{
  "required": [
    "assetIds",
    "dataChannelIdType",
    "latestNValues",
    "typeOption"
  ],
  "type": "object",
  "properties": {
    "assetIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "dataChannelIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "typeOption": {
      "enum": [
        "Data",
        "Sdd",
        "SddData",
        "Events"
      ],
      "type": "string"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "latestNValues": {
      "type": "integer",
      "format": "int32"
    },
    "dataChannelIdType": {
      "enum": [
        "DataChannelUuid",
        "LocalId",
        "ShortId",
        "UniversalId",
        "Alias"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "assetIds": [
    "string"
  ],
  "dataChannelIds": [
    "string"
  ],
  "typeOption": "Data",
  "dimensions": [
    "string"
  ],
  "latestNValues": 0,
  "dataChannelIdType": "DataChannelUuid"
}

{
  "required": [
    "assetIds",
    "dataChannelIdType",
    "latestNValues",
    "typeOption"
  ],
  "type": "object",
  "properties": {
    "assetIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "dataChannelIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "typeOption": {
      "enum": [
        "Data",
        "Sdd",
        "SddData",
        "Events"
      ],
      "type": "string"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "latestNValues": {
      "type": "integer",
      "format": "int32"
    },
    "dataChannelIdType": {
      "enum": [
        "DataChannelUuid",
        "LocalId",
        "ShortId",
        "UniversalId",
        "Alias"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "assetIds": [
    "string"
  ],
  "dataChannelIds": [
    "string"
  ],
  "typeOption": "Data",
  "dimensions": [
    "string"
  ],
  "latestNValues": 0,
  "dataChannelIdType": "DataChannelUuid"
}

{
  "required": [
    "assetIds",
    "dataChannelIdType",
    "latestNValues",
    "typeOption"
  ],
  "type": "object",
  "properties": {
    "assetIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "dataChannelIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "typeOption": {
      "enum": [
        "Data",
        "Sdd",
        "SddData",
        "Events"
      ],
      "type": "string"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "latestNValues": {
      "type": "integer",
      "format": "int32"
    },
    "dataChannelIdType": {
      "enum": [
        "DataChannelUuid",
        "LocalId",
        "ShortId",
        "UniversalId",
        "Alias"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "assetIds": [
    "string"
  ],
  "dataChannelIds": [
    "string"
  ],
  "typeOption": "Data",
  "dimensions": [
    "string"
  ],
  "latestNValues": 0,
  "dataChannelIdType": "DataChannelUuid"
}

{
  "required": [
    "assetIds",
    "dataChannelIdType",
    "latestNValues",
    "typeOption"
  ],
  "type": "object",
  "properties": {
    "assetIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "dataChannelIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "typeOption": {
      "enum": [
        "Data",
        "Sdd",
        "SddData",
        "Events"
      ],
      "type": "string"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "latestNValues": {
      "type": "integer",
      "format": "int32"
    },
    "dataChannelIdType": {
      "enum": [
        "DataChannelUuid",
        "LocalId",
        "ShortId",
        "UniversalId",
        "Alias"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Responses

200 OK

Returns data points for given signal ids.

Representations

{
  "type": "object",
  "properties": {
    "dataPoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "assetId": {
            "type": "string",
            "nullable": true
          },
          "tagUuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "tagId": {
            "type": "string",
            "nullable": true
          },
          "dimension": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "quality": {
            "type": "string",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "received": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "kustoTableHint": {
            "type": "string",
            "nullable": true,
            "deprecated": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "downScaledDataPoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assetId": {
            "type": "string",
            "nullable": true
          },
          "tagUuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "tagId": {
            "type": "string",
            "nullable": true
          },
          "dimension": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "avg": {
            "type": "number",
            "format": "double"
          },
          "min": {
            "type": "number",
            "format": "double"
          },
          "max": {
            "type": "number",
            "format": "double"
          },
          "standardDeviation": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "dataPoints": [
    {
      "id": "string",
      "assetId": "string",
      "tagUuid": "string",
      "tagId": "string",
      "dimension": "string",
      "value": {},
      "quality": "string",
      "timestamp": "string",
      "received": "string",
      "kustoTableHint": "string"
    }
  ],
  "downScaledDataPoints": [
    {
      "assetId": "string",
      "tagUuid": "string",
      "tagId": "string",
      "dimension": "string",
      "value": {},
      "timestamp": "string",
      "avg": 0.0,
      "min": 0.0,
      "max": 0.0,
      "standardDeviation": 0.0
    }
  ]
}

{
  "type": "object",
  "properties": {
    "dataPoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "assetId": {
            "type": "string",
            "nullable": true
          },
          "tagUuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "tagId": {
            "type": "string",
            "nullable": true
          },
          "dimension": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "quality": {
            "type": "string",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "received": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "kustoTableHint": {
            "type": "string",
            "nullable": true,
            "deprecated": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "downScaledDataPoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assetId": {
            "type": "string",
            "nullable": true
          },
          "tagUuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "tagId": {
            "type": "string",
            "nullable": true
          },
          "dimension": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "avg": {
            "type": "number",
            "format": "double"
          },
          "min": {
            "type": "number",
            "format": "double"
          },
          "max": {
            "type": "number",
            "format": "double"
          },
          "standardDeviation": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "dataPoints": [
    {
      "id": "string",
      "assetId": "string",
      "tagUuid": "string",
      "tagId": "string",
      "dimension": "string",
      "value": {},
      "quality": "string",
      "timestamp": "string",
      "received": "string",
      "kustoTableHint": "string"
    }
  ],
  "downScaledDataPoints": [
    {
      "assetId": "string",
      "tagUuid": "string",
      "tagId": "string",
      "dimension": "string",
      "value": {},
      "timestamp": "string",
      "avg": 0.0,
      "min": 0.0,
      "max": 0.0,
      "standardDeviation": 0.0
    }
  ]
}

{
  "type": "object",
  "properties": {
    "dataPoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "assetId": {
            "type": "string",
            "nullable": true
          },
          "tagUuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "tagId": {
            "type": "string",
            "nullable": true
          },
          "dimension": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "quality": {
            "type": "string",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "received": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "kustoTableHint": {
            "type": "string",
            "nullable": true,
            "deprecated": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "downScaledDataPoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assetId": {
            "type": "string",
            "nullable": true
          },
          "tagUuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "tagId": {
            "type": "string",
            "nullable": true
          },
          "dimension": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "avg": {
            "type": "number",
            "format": "double"
          },
          "min": {
            "type": "number",
            "format": "double"
          },
          "max": {
            "type": "number",
            "format": "double"
          },
          "standardDeviation": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

400 Bad Request

Something is wrong with the request format. Please see error details.

Representations

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "errors": {
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "traceId": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    },
    "error": {
      "type": "object",
      "properties": {
        "errors": {
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "traceId": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "data": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  },
  "error": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "errors": {
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "traceId": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    },
    "error": {
      "type": "object",
      "properties": {
        "errors": {
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "traceId": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Sample
Schema

{
  "data": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  },
  "error": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "errors": {
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "traceId": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    },
    "error": {
      "type": "object",
      "properties": {
        "errors": {
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "traceId": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

500 Internal Server Error

Server error. Application has crashed.

Code samples

@ECHO OFF

curl -v -X POST "https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest"
-H "x-requestidentifier: "
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("x-requestidentifier", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            var uri = "https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("x-requestidentifier", "");
            request.setHeader("Content-Type", "application/json-patch+json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("x-requestidentifier","");
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"x-requestidentifier"];
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'x-requestidentifier' => '',
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'x-requestidentifier': '',
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.veracity.com')
    conn.request("POST", "/veracity/timeseries2/api/v2/timeSeries/latest?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'x-requestidentifier': '',
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.veracity.com')
    conn.request("POST", "/veracity/timeseries2/api/v2/timeSeries/latest?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://api.veracity.com/veracity/timeseries2/api/v2/timeSeries/latest')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['x-requestidentifier'] = ''
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body