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 values

Returns last values of unit (e.g. RPM…)

Try it

Request

Request URL

https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/values[?valueGuids]

Request parameters

loginId

string

WSV account you want to access via API
unitGuid

string

Unique Unit identifier
valueGuids (optional)

string

Unique value identifier (accept multiple guids separated by commas). Leave blank to show all possible values in the Unit

Request headers

Authorization

string

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

string

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

Request body

Responses

200 OK

Returns all/selected values from the Unit

Response values:

name: name of the Unit, same as in Websupervisor. (string)
unitGuid: unique static identification of the Unit. (string)
values: field of the Unit values (field)
name: name of the value, same as in Websupervisor. (string)
valueGuid: unique static identification of the value. (string)
value: current value. Can be a list of values if applicable. (string)
unit: the physical units. (string)
highLimit: value high limit configured in the Websupervisor. Just for values, where it is applicable. (number)
lowLimit: value low limit configured in the Websupervisor. Just for values, where it is applicable. (number)
decimalPlaces: decimal places of the value. (number)
timeStamp: the timestamp, when the value has been read from the Unit. (string)

Representations

application/json

{
  "name": "Controller 1",
  "unitGuid": "gensete5ffa1149c0c85b9a4238f8a2e812130",
  "values": [
    {
      "name": "Last Update",
      "valueGuid": "0C9117DA-495A-11DF-85EB-428556D89593",
      "value": "2018-06-10T19:08:14.635Z",
      "unit": "",
      "highLimit": 0,
      "lowLimit": 0,
      "decimalPlaces": 0,
      "timeStamp": "2018-06-10T19:08:14.635Z"
    },
    {
      "name": "RPM",
      "valueGuid": "6629f84f-4b79-43c2-ab33-1f27f1f8c42b",
      "value": 1500,
      "unit": "RPM",
      "highLimit": 3000,
      "lowLimit": 0,
      "decimalPlaces": 0,
      "timeStamp": "2018-06-10T19:08:12.94Z"
    }
  ]
}

400 Bad Request

Response when incorrect unitGuid is provided

Representations

application/json

401 Unauthorized

Response when incorrect or expired token is provided

Representations

application/json

Code samples

@ECHO OFF

curl -v -X GET "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/values?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["valueGuids"] = "{string}";
            var uri = "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/values?" + 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}/values");

            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
            "valueGuids": "{string}",
        };
      
        $.ajax({
            url: "https://api.websupervisor.net/v1.1/{loginId}/units/{unitGuid}/values?" + $.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}/values";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"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}/values');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '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
    'valueGuids': '{string}',
})

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

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

query = URI.encode_www_form({
    # Request parameters
    '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