WebSupervisor API

API change history

API allows customers to obtain data from their units using HTTP methods, such as GET, POST, PUT, and DELETE. REST API is easy to use and scalable, allowing customers to obtain data from units in near real-time. Depending on WSV refresh period.

Unit history

Returns historical values of unit (e.g. RPM…)
In case of request for bigger amout of data, it has to be split into several requests and use sequential data read. For this purpose requests contain attribute offset. Response has attribute nextOffset. Limit for one response is 200 kB.
Caution: Data in the response are formatted as, that only changes in value are stored. In response you obtain the value and from/to the period when it was valid. For timeline applications, you have to parse data in the application.

Try it

Request

Request URL

Request parameters

  • string

    WSV account you want to access via API

  • string

    Unique unit identifier

  • (optional)
    string

    History is provided from this date, default value is first day in actual month, format MM/DD/YYYY

  • (optional)
    string

    History is provided until this date, default value is time of the query, format MM/DD/YYYY

  • (optional)
    string

    Offset address for the next batch of values, default value is 0

  • (optional)
    string

    Unique value identifier

Request headers

  • string

    Header for token type + access token, i.e. "Bearer asd....fg12"

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

Request body

Responses

200 OK

Returns list of historical values

Response values:

name: name of the Unit, same as in Websupervisor. (string)
unitGuid: unique static identification of the Unit. (string)
nextOffset: address to obtain the next batch of data. Should be used in the offset parameter in the request. "null" if there is no next batch (number)
values: list of the historical values with period of validity. (field)
  name: name of the value, same as in the Websupervisor. (string)
  valueGuid: unique static identifier of the value. (string)
  history: list of the historical values with a period of validity. (field)
    value: valid value in the period. (type depends on the value)
    validFrom: value valid from. (string)
    validTo: value valid to. (string)

Representations

{
  "name": "Controller 1",
  "unitGuid": "gensete5ffa1149c0c85b9a4238f8a2e812130",
  "nextOffset": null,
  "values": [
    {
      "name": "RPM",
      "valueGuid": "6629f84f-4b79-43c2-ab33-1f27f1f8c42b",
      "history": [
        {
          "value": 1500,
          "validTo": "2018-06-10T11:44:02.437Z"
        },
        {
          "value": 1501,
          "validTo": "2018-06-10T13:38:32.731Z"
        },
        {
          "value": 1500,
          "validTo": "2018-06-10T19:37:52.653Z"
        }
      ],
      "unit": "RPM",
      "decimalPlaces": 0
    }
  ]
}

400 Bad Request

Response when incorrect unitGuid is provided

Representations

401 Unauthorized

Response when incorrect or expired token is provided

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history?from={string}&to={string}&offset={string}&valueGuids={string}"
-H "Authorization: "
-H "Comap-Key: {subscription key}"

--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("Authorization", "");
            client.DefaultRequestHeaders.Add("Comap-Key", "{subscription key}");

            // Request parameters
            queryString["from"] = "{string}";
            queryString["to"] = "{string}";
            queryString["offset"] = "{string}";
            queryString["valueGuids"] = "{string}";
            var uri = "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history");

            builder.setParameter("from", "{string}");
            builder.setParameter("to", "{string}");
            builder.setParameter("offset", "{string}");
            builder.setParameter("valueGuids", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Comap-Key", "{subscription key}");


            // 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
            "from": "{string}",
            "to": "{string}",
            "offset": "{string}",
            "valueGuids": "{string}",
        };
      
        $.ajax({
            url: "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Comap-Key","{subscription key}");
            },
            type: "GET",
            // 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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"from={string}",
                         @"to={string}",
                         @"offset={string}",
                         @"valueGuids={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Comap-Key"];
    // 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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Comap-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'from' => '{string}',
    'to' => '{string}',
    'offset' => '{string}',
    'valueGuids' => '{string}',
);

$url->setQueryVariables($parameters);

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

// 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
    'Authorization': '',
    'Comap-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'from': '{string}',
    'to': '{string}',
    'offset': '{string}',
    'valueGuids': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.websupervisor.net')
    conn.request("GET", "/v1.1/{loginId}/units/{unitGuid}/history?%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
    'Authorization': '',
    'Comap-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'from': '{string}',
    'to': '{string}',
    'offset': '{string}',
    'valueGuids': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.websupervisor.net')
    conn.request("GET", "/v1.1/{loginId}/units/{unitGuid}/history?%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.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/history')

query = URI.encode_www_form({
    # Request parameters
    'from' => '{string}',
    'to' => '{string}',
    'offset' => '{string}',
    'valueGuids' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Comap-Key'] = '{subscription key}'
# 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