Provision API
API change historyUpdate Metadata
JSON Patch (https://tools.ietf.org/html/rfc6902) defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The "application/json-patch+json" media type is used to identify such patch documents.
Example in this case: { "value": "My new container name", "path": "Title", "op": "replace" }, This operation would replace the title
A other example for update of tags (NOTE: remember to update the list of tags with all the tags) { "value": [ { "Title" :"First tag" }, { "Title" : "Second tag" }
], "path": "Tags", "op": "replace" } This operation would replace the tags
Try itRequest
Request URL
Request parameters
-
string
Format - uuid.
Request headers
-
(optional)stringMedia type of the body sent to the API.
-
stringOAuth 2.0 access token obtained from B2C PROD OAuth - v2 endpoint. Supported grant types: Authorization code.
Request body
{
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}{
"type": "object",
"properties": {
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "object"
},
"path": {
"type": "string"
},
"op": {
"type": "string"
},
"from": {
"type": "string"
}
}
},
"readOnly": true
}
},
"example": {
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}
}{
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}{
"type": "object",
"properties": {
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "object"
},
"path": {
"type": "string"
},
"op": {
"type": "string"
},
"from": {
"type": "string"
}
}
},
"readOnly": true
}
},
"example": {
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}
}{
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}{
"type": "object",
"properties": {
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "object"
},
"path": {
"type": "string"
},
"op": {
"type": "string"
},
"from": {
"type": "string"
}
}
},
"readOnly": true
}
},
"example": {
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}
}{
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}{
"type": "object",
"properties": {
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "object"
},
"path": {
"type": "string"
},
"op": {
"type": "string"
},
"from": {
"type": "string"
}
}
},
"readOnly": true
}
},
"example": {
"operations": [
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
}
}Responses
200 OK
Metadata was updated
Representations
{
"id": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"url": "string",
"lastModifiedUTC": "string",
"creationDateTimeUTC": "string",
"ownerId": "00000000-0000-0000-0000-000000000000",
"accessLevel": "owner",
"region": "string",
"keyStatus": "noKeys",
"mayContainPersonalData": "unknown",
"metadata": {
"title": "string",
"description": "string",
"icon": {
"id": "string",
"backgroundColor": "string"
},
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"type": "userTag"
}
]
}
}{
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"reference": {
"type": "string"
},
"url": {
"type": "string"
},
"lastModifiedUTC": {
"format": "date-time",
"type": "string"
},
"creationDateTimeUTC": {
"format": "date-time",
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accessLevel": {
"enum": [
"owner",
"dataSteward",
"consumer"
],
"type": "string"
},
"region": {
"type": "string"
},
"keyStatus": {
"enum": [
"noKeys",
"expired",
"available",
"active"
],
"type": "string"
},
"mayContainPersonalData": {
"enum": [
"unknown",
"true",
"false"
],
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"backgroundColor": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"userTag",
"systemTag"
],
"type": "string"
}
}
}
}
}
}
}
}{
"id": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"url": "string",
"lastModifiedUTC": "string",
"creationDateTimeUTC": "string",
"ownerId": "00000000-0000-0000-0000-000000000000",
"accessLevel": "owner",
"region": "string",
"keyStatus": "noKeys",
"mayContainPersonalData": "unknown",
"metadata": {
"title": "string",
"description": "string",
"icon": {
"id": "string",
"backgroundColor": "string"
},
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"type": "userTag"
}
]
}
}{
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"reference": {
"type": "string"
},
"url": {
"type": "string"
},
"lastModifiedUTC": {
"format": "date-time",
"type": "string"
},
"creationDateTimeUTC": {
"format": "date-time",
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accessLevel": {
"enum": [
"owner",
"dataSteward",
"consumer"
],
"type": "string"
},
"region": {
"type": "string"
},
"keyStatus": {
"enum": [
"noKeys",
"expired",
"available",
"active"
],
"type": "string"
},
"mayContainPersonalData": {
"enum": [
"unknown",
"true",
"false"
],
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"backgroundColor": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"userTag",
"systemTag"
],
"type": "string"
}
}
}
}
}
}
}
}<Resource>
<id>00000000-0000-0000-0000-000000000000</id>
<reference>string</reference>
<url>string</url>
<lastModifiedUTC>string</lastModifiedUTC>
<creationDateTimeUTC>string</creationDateTimeUTC>
<ownerId>00000000-0000-0000-0000-000000000000</ownerId>
<accessLevel>owner</accessLevel>
<region>string</region>
<keyStatus>noKeys</keyStatus>
<mayContainPersonalData>unknown</mayContainPersonalData>
<metadata>
<title>string</title>
<description>string</description>
<icon>
<id>string</id>
<backgroundColor>string</backgroundColor>
</icon>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<title>string</title>
<type>userTag</type>
</tags>
</metadata>
</Resource>{
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"reference": {
"type": "string"
},
"url": {
"type": "string"
},
"lastModifiedUTC": {
"format": "date-time",
"type": "string"
},
"creationDateTimeUTC": {
"format": "date-time",
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accessLevel": {
"enum": [
"owner",
"dataSteward",
"consumer"
],
"type": "string"
},
"region": {
"type": "string"
},
"keyStatus": {
"enum": [
"noKeys",
"expired",
"available",
"active"
],
"type": "string"
},
"mayContainPersonalData": {
"enum": [
"unknown",
"true",
"false"
],
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"backgroundColor": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"userTag",
"systemTag"
],
"type": "string"
}
}
}
}
}
}
}
}<Resource>
<id>00000000-0000-0000-0000-000000000000</id>
<reference>string</reference>
<url>string</url>
<lastModifiedUTC>string</lastModifiedUTC>
<creationDateTimeUTC>string</creationDateTimeUTC>
<ownerId>00000000-0000-0000-0000-000000000000</ownerId>
<accessLevel>owner</accessLevel>
<region>string</region>
<keyStatus>noKeys</keyStatus>
<mayContainPersonalData>unknown</mayContainPersonalData>
<metadata>
<title>string</title>
<description>string</description>
<icon>
<id>string</id>
<backgroundColor>string</backgroundColor>
</icon>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<title>string</title>
<type>userTag</type>
</tags>
</metadata>
</Resource>{
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"reference": {
"type": "string"
},
"url": {
"type": "string"
},
"lastModifiedUTC": {
"format": "date-time",
"type": "string"
},
"creationDateTimeUTC": {
"format": "date-time",
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accessLevel": {
"enum": [
"owner",
"dataSteward",
"consumer"
],
"type": "string"
},
"region": {
"type": "string"
},
"keyStatus": {
"enum": [
"noKeys",
"expired",
"available",
"active"
],
"type": "string"
},
"mayContainPersonalData": {
"enum": [
"unknown",
"true",
"false"
],
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"backgroundColor": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"userTag",
"systemTag"
],
"type": "string"
}
}
}
}
}
}
}
}403 Forbidden
Not resource owner
Representations
404 Not Found
Resource was not found
Representations
500 Internal Server Error
Container metadata was not updated
Representations
Code samples
@ECHO OFF
curl -v -X PATCH "https://api.veracity.com/veracity/datafabric/provisioning/api/1/container/{id}/metadata"
-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}");
var uri = "https://api.veracity.com/veracity/datafabric/provisioning/api/1/container/{id}/metadata?" + queryString;
}
}
} // // 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/provisioning/api/1/container/{id}/metadata");
URI uri = builder.build();
HttpPatch request = new HttpPatch(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
};
$.ajax({
url: "https://api.veracity.com/veracity/datafabric/provisioning/api/1/container/{id}/metadata?" + $.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: "PATCH",
// 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/provisioning/api/1/container/{id}/metadata";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PATCH"];
// 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/datafabric/provisioning/api/1/container/{id}/metadata');
$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
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PATCH);
// 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({
})
try:
conn = httplib.HTTPSConnection('api.veracity.com')
conn.request("PATCH", "/veracity/datafabric/provisioning/api/1/container/{id}/metadata?%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({
})
try:
conn = http.client.HTTPSConnection('api.veracity.com')
conn.request("PATCH", "/veracity/datafabric/provisioning/api/1/container/{id}/metadata?%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/provisioning/api/1/container/{id}/metadata')
request = Net::HTTP::Patch.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