Asset
API change historyVeracity Asset 2.0 API
Request
Request URL
Request parameters
-
string
Format - uuid. The workspace Id
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
The user id and the new role
{
"userId": "string",
"accessRole": "None"
}
{
"required": [
"accessRole",
"userId"
],
"type": "object",
"properties": {
"userId": {
"format": "uuid",
"type": "string"
},
"accessRole": {
"enum": [
"None",
"Reader",
"Contributor",
"Admin",
"Guest"
],
"type": "string"
}
}
}
{
"userId": "string",
"accessRole": "None"
}
{
"required": [
"accessRole",
"userId"
],
"type": "object",
"properties": {
"userId": {
"format": "uuid",
"type": "string"
},
"accessRole": {
"enum": [
"None",
"Reader",
"Contributor",
"Admin",
"Guest"
],
"type": "string"
}
}
}
{
"userId": "string",
"accessRole": "None"
}
{
"required": [
"accessRole",
"userId"
],
"type": "object",
"properties": {
"userId": {
"format": "uuid",
"type": "string"
},
"accessRole": {
"enum": [
"None",
"Reader",
"Contributor",
"Admin",
"Guest"
],
"type": "string"
}
}
}
{
"userId": "string",
"accessRole": "None"
}
{
"required": [
"accessRole",
"userId"
],
"type": "object",
"properties": {
"userId": {
"format": "uuid",
"type": "string"
},
"accessRole": {
"enum": [
"None",
"Reader",
"Contributor",
"Admin",
"Guest"
],
"type": "string"
}
}
}
Responses
200 OK
Success
Representations
{
"type": "object",
"properties": {
"data": {},
"error": {
"type": "object",
"properties": {
"errors": {},
"title": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"traceId": {
"type": "string"
}
}
}
}
}
{
"data": {},
"error": {
"errors": {},
"title": "string",
"status": 0,
"traceId": "string"
}
}
{
"type": "object",
"properties": {
"data": {},
"error": {
"type": "object",
"properties": {
"errors": {},
"title": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"traceId": {
"type": "string"
}
}
}
}
}
{
"data": {},
"error": {
"errors": {},
"title": "string",
"status": 0,
"traceId": "string"
}
}
{
"type": "object",
"properties": {
"data": {},
"error": {
"type": "object",
"properties": {
"errors": {},
"title": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"traceId": {
"type": "string"
}
}
}
}
}
204 No Content
Updated the role of the specified user.
Representations
400 Bad Request
Invalid input, check the message for details.
Representations
401 Unauthorized
Unauthorized
Representations
403 Forbidden
Operation not allowed, see message for details.
Representations
404 Not Found
Resource not found, see message for details.
Representations
Code samples
@ECHO OFF
curl -v -X PUT "https://api.veracity.com/veracity/assets/api/v1/Workspaces/{id}/user"
-H "Content-Type: application/json-patch+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/assets/api/v1/Workspaces/{id}/user?" + 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.PutAsync(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/assets/api/v1/Workspaces/{id}/user");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("Content-Type", "application/json-patch+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/assets/api/v1/Workspaces/{id}/user?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
type: "PUT",
// 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/assets/api/v1/Workspaces/{id}/user";
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:@"PUT"];
// Request headers
[_request setValue:@"application/json-patch+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/assets/api/v1/Workspaces/{id}/user');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-patch+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_PUT);
// 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-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.veracity.com')
conn.request("PUT", "/veracity/assets/api/v1/Workspaces/{id}/user?%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-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.veracity.com')
conn.request("PUT", "/veracity/assets/api/v1/Workspaces/{id}/user?%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/assets/api/v1/Workspaces/{id}/user')
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+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