Data Fabric IoT Event Ingest API

API change history

Veracity Data Fabric IoT API

Creates an Event by template.

Creates an Event by template.

Try it

Request

Request URL

Request parameters

  • string

    Asset Id

  • string

    Asset Id schema

  • string

    E.g: Voyagereport, Topologyreport

  • string

    DataChannel Identifier

  • (optional)
    string

    Event Identifier

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). Timestamp in UTC time. Default to "now"

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from B2C PROD OAuth - v2 endpoint. Supported grant types: Authorization code.

Request body

Event body (max 3000 chars)

{}
{
  "x-apim-inline": true
}

Responses

200 OK

Success

Representations

{
  "data": "string"
}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

400 Bad Request

Bad Request

Representations

{
  "error": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  }
}
{
  "type": "object",
  "properties": {
    "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
}

403 Forbidden

Forbidden

Representations

{
  "error": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  }
}
{
  "type": "object",
  "properties": {
    "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
}

404 Not Found

Not Found

Representations

{
  "error": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  }
}
{
  "type": "object",
  "properties": {
    "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

Representations

{
  "error": {
    "errors": {},
    "title": "string",
    "status": 0,
    "traceId": "string"
  }
}
{
  "type": "object",
  "properties": {
    "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
}

401 Unauthorized

Not authorized

405 Method Not Allowed

Method not allowed

415 Unsupported Media Type

Unsupported media type

Code samples

@ECHO OFF

curl -v -X POST "https://api.veracity.com/veracity/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}?eventId={string}&timeStampUtc={string}"
-H "Content-Type: application/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("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["eventId"] = "{string}";
            queryString["timeStampUtc"] = "{string}";
            var uri = "https://api.veracity.com/veracity/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}&" + 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/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}");

            builder.setParameter("eventId", "{string}");
            builder.setParameter("timeStampUtc", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/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
            "eventId": "{string}",
            "timeStampUtc": "{string}",
        };
      
        $.ajax({
            url: "https://api.veracity.com/veracity/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/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/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"eventId={string}",
                         @"timeStampUtc={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/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/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'eventId' => '{string}',
    'timeStampUtc' => '{string}',
);

$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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'eventId': '{string}',
    'timeStampUtc': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.veracity.com')
    conn.request("POST", "/veracity/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}&%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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'eventId': '{string}',
    'timeStampUtc': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.veracity.com')
    conn.request("POST", "/veracity/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}&%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/ioteventsingest2/api/v2/assets/{assetId}/event?assetIdSchema={assetIdSchema}&eventType={eventType}&dataChannelID={dataChannelID}')

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

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/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