Asset Metadata Management -- Query API

MMS solution Query API

Search sites using available filters.

Request

Request URL

https://api.veracity.com/veracity/mms/query/{__tenant__}/api/v1/sites[?start][&pageSize][&sortColumn][&sortDirection][&nameFilter][&standardVersion]

Request parameters

__tenant__

string
start (optional)

integer

Format - int32.
pageSize (optional)

integer

Format - int32.
sortColumn (optional)

string
sortDirection (optional)
nameFilter (optional)

string
standardVersion (optional)

string

Request headers

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.

Request body

Responses

200 OK

Representations

application/json

Sample
Schema

{
  "totalRecords": 0,
  "data": {},
  "page": 0
}

{
  "type": "object",
  "properties": {
    "totalRecords": {
      "type": "integer",
      "format": "int32"
    },
    "data": {},
    "page": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.veracity.com/veracity/mms/query/{__tenant__}/api/v1/sites?start=0&pageSize=10&sortColumn=SiteName&sortDirection=0&nameFilter={string}&standardVersion={string}"
-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["start"] = "0";
            queryString["pageSize"] = "10";
            queryString["sortColumn"] = "SiteName";
            queryString["sortDirection"] = "0";
            queryString["nameFilter"] = "{string}";
            queryString["standardVersion"] = "{string}";
            var uri = "https://api.veracity.com/veracity/mms/query/{__tenant__}/api/v1/sites?" + 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.veracity.com/veracity/mms/query/{__tenant__}/api/v1/sites");

            builder.setParameter("start", "0");
            builder.setParameter("pageSize", "10");
            builder.setParameter("sortColumn", "SiteName");
            builder.setParameter("sortDirection", "0");
            builder.setParameter("nameFilter", "{string}");
            builder.setParameter("standardVersion", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "start": "0",
            "pageSize": "10",
            "sortColumn": "SiteName",
            "sortDirection": "0",
            "nameFilter": "{string}",
            "standardVersion": "{string}",
        };
      
        $.ajax({
            url: "https://api.veracity.com/veracity/mms/query/{__tenant__}/api/v1/sites?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            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.veracity.com/veracity/mms/query/{__tenant__}/api/v1/sites";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"start=0",
                         @"pageSize=10",
                         @"sortColumn=SiteName",
                         @"sortDirection=0",
                         @"nameFilter={string}",
                         @"standardVersion={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:@"{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/mms/query/{__tenant__}/api/v1/sites');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'start' => '0',
    'pageSize' => '10',
    'sortColumn' => 'SiteName',
    'sortDirection' => '0',
    'nameFilter' => '{string}',
    'standardVersion' => '{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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'start': '0',
    'pageSize': '10',
    'sortColumn': 'SiteName',
    'sortDirection': '0',
    'nameFilter': '{string}',
    'standardVersion': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.veracity.com')
    conn.request("GET", "/veracity/mms/query/{__tenant__}/api/v1/sites?%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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'start': '0',
    'pageSize': '10',
    'sortColumn': 'SiteName',
    'sortDirection': '0',
    'nameFilter': '{string}',
    'standardVersion': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.veracity.com')
    conn.request("GET", "/veracity/mms/query/{__tenant__}/api/v1/sites?%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/mms/query/{__tenant__}/api/v1/sites')

query = URI.encode_www_form({
    # Request parameters
    'start' => '0',
    'pageSize' => '10',
    'sortColumn' => 'SiteName',
    'sortDirection' => '0',
    'nameFilter' => '{string}',
    'standardVersion' => '{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['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