Data API
API change historyRetrieves a list of Providers that have access to a specified resource.
Get a list of all providers with accesses for a given storage item per page, using a page number and page size. Note the variable keyCreatedTimeUTC is the time the SAS key generated is valid from, this is set one hour in the past from the time created this to avoid azure time skew issues.
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Azure resource
-
(optional)integer
Format - int32. Page number. Defaults to 1.
-
(optional)integer
Format - int32. Number of results per page. Defaults to 50. If this is a negative number, all results will be fetched
Request headers
-
stringOAuth 2.0 access token obtained from B2C PROD OAuth - v2 endpoint. Supported grant types: Authorization code.
Request body
Responses
200 OK
OK
Representations
{
"results": [
{
"userId": "00000000-0000-0000-0000-000000000000",
"ownerId": "00000000-0000-0000-0000-000000000000",
"grantedById": "00000000-0000-0000-0000-000000000000",
"accessSharingId": "00000000-0000-0000-0000-000000000000",
"keyCreated": true,
"autoRefreshed": true,
"keyCreatedTimeUTC": "string",
"keyExpiryTimeUTC": "string",
"resourceType": "string",
"accessHours": 0,
"accessKeyTemplateId": "00000000-0000-0000-0000-000000000000",
"attribute1": true,
"attribute2": true,
"attribute3": true,
"attribute4": true,
"resourceId": "00000000-0000-0000-0000-000000000000",
"ipRange": {
"startIp": "string",
"endIp": "string"
},
"comment": "string"
}
],
"page": 0,
"resultsPerPage": 0,
"totalPages": 0,
"totalResults": 0
}
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"ownerId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"grantedById": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accessSharingId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"keyCreated": {
"type": "boolean"
},
"autoRefreshed": {
"type": "boolean"
},
"keyCreatedTimeUTC": {
"format": "date-time",
"type": "string"
},
"keyExpiryTimeUTC": {
"format": "date-time",
"type": "string"
},
"resourceType": {
"type": "string"
},
"accessHours": {
"format": "int32",
"type": "integer"
},
"accessKeyTemplateId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"attribute1": {
"type": "boolean"
},
"attribute2": {
"type": "boolean"
},
"attribute3": {
"type": "boolean"
},
"attribute4": {
"type": "boolean"
},
"resourceId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"ipRange": {
"type": "object",
"properties": {
"startIp": {
"type": "string"
},
"endIp": {
"type": "string"
}
}
},
"comment": {
"type": "string"
}
}
},
"readOnly": true
},
"page": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"resultsPerPage": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"totalPages": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"totalResults": {
"format": "int64",
"type": "integer",
"readOnly": true
}
}
}
{
"results": [
{
"userId": "00000000-0000-0000-0000-000000000000",
"ownerId": "00000000-0000-0000-0000-000000000000",
"grantedById": "00000000-0000-0000-0000-000000000000",
"accessSharingId": "00000000-0000-0000-0000-000000000000",
"keyCreated": true,
"autoRefreshed": true,
"keyCreatedTimeUTC": "string",
"keyExpiryTimeUTC": "string",
"resourceType": "string",
"accessHours": 0,
"accessKeyTemplateId": "00000000-0000-0000-0000-000000000000",
"attribute1": true,
"attribute2": true,
"attribute3": true,
"attribute4": true,
"resourceId": "00000000-0000-0000-0000-000000000000",
"ipRange": {
"startIp": "string",
"endIp": "string"
},
"comment": "string"
}
],
"page": 0,
"resultsPerPage": 0,
"totalPages": 0,
"totalResults": 0
}
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"ownerId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"grantedById": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accessSharingId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"keyCreated": {
"type": "boolean"
},
"autoRefreshed": {
"type": "boolean"
},
"keyCreatedTimeUTC": {
"format": "date-time",
"type": "string"
},
"keyExpiryTimeUTC": {
"format": "date-time",
"type": "string"
},
"resourceType": {
"type": "string"
},
"accessHours": {
"format": "int32",
"type": "integer"
},
"accessKeyTemplateId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"attribute1": {
"type": "boolean"
},
"attribute2": {
"type": "boolean"
},
"attribute3": {
"type": "boolean"
},
"attribute4": {
"type": "boolean"
},
"resourceId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"ipRange": {
"type": "object",
"properties": {
"startIp": {
"type": "string"
},
"endIp": {
"type": "string"
}
}
},
"comment": {
"type": "string"
}
}
},
"readOnly": true
},
"page": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"resultsPerPage": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"totalPages": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"totalResults": {
"format": "int64",
"type": "integer",
"readOnly": true
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.veracity.com/veracity/datafabric/data/api/1/resources/{resourceId}/accesses?pageNo={integer}&pageSize={integer}"
-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["pageNo"] = "{integer}";
queryString["pageSize"] = "{integer}";
var uri = "https://api.veracity.com/veracity/datafabric/data/api/1/resources/{resourceId}/accesses?" + 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/datafabric/data/api/1/resources/{resourceId}/accesses");
builder.setParameter("pageNo", "{integer}");
builder.setParameter("pageSize", "{integer}");
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
"pageNo": "{integer}",
"pageSize": "{integer}",
};
$.ajax({
url: "https://api.veracity.com/veracity/datafabric/data/api/1/resources/{resourceId}/accesses?" + $.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/datafabric/data/api/1/resources/{resourceId}/accesses";
NSArray* array = @[
// Request parameters
@"entities=true",
@"pageNo={integer}",
@"pageSize={integer}",
];
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/datafabric/data/api/1/resources/{resourceId}/accesses');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'pageNo' => '{integer}',
'pageSize' => '{integer}',
);
$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
'pageNo': '{integer}',
'pageSize': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.veracity.com')
conn.request("GET", "/veracity/datafabric/data/api/1/resources/{resourceId}/accesses?%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
'pageNo': '{integer}',
'pageSize': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.veracity.com')
conn.request("GET", "/veracity/datafabric/data/api/1/resources/{resourceId}/accesses?%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/datafabric/data/api/1/resources/{resourceId}/accesses')
query = URI.encode_www_form({
# Request parameters
'pageNo' => '{integer}',
'pageSize' => '{integer}'
})
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