Data API

API change history

Transfer the ownership of the Azure resource to a specified user. Both previous and the new owner should be affiliated with the same company.

Returns the Azure resource with updated OwnerId field.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. The Id of the resource

  • string

    Format - uuid. The Id of the user with role of Data Manager that ownership will be transfered to.

  • (optional)
    boolean

    The endpoint specified below will be updated with an Input flag. When the "SetPreviousOwnerAsDataSteward" flag is set to true. If it is false, then the previous owner will not be assigned as Data Steward.

Request headers

  • 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

Responses

200 OK

OK

Representations

{
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "resourceName": "string",
  "resourceUrl": "string",
  "lastModifiedUTC": "string",
  "creationDateTimeUTC": "string",
  "ownerId": "00000000-0000-0000-0000-000000000000",
  "resourceType": "string",
  "resourceRegion": "string",
  "mayContainPersonalData": "unknown",
  "metadata": {
    "title": "string",
    "description": "string",
    "icon": {
      "id": "string",
      "backgroundColor": "string"
    },
    "tags": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "title": "string"
      }
    ]
  }
}
{
  "type": "object",
  "properties": {
    "resourceId": {
      "format": "uuid",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "resourceName": {
      "type": "string"
    },
    "resourceUrl": {
      "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"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceRegion": {
      "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"
              }
            }
          }
        }
      }
    }
  }
}
{
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "resourceName": "string",
  "resourceUrl": "string",
  "lastModifiedUTC": "string",
  "creationDateTimeUTC": "string",
  "ownerId": "00000000-0000-0000-0000-000000000000",
  "resourceType": "string",
  "resourceRegion": "string",
  "mayContainPersonalData": "unknown",
  "metadata": {
    "title": "string",
    "description": "string",
    "icon": {
      "id": "string",
      "backgroundColor": "string"
    },
    "tags": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "title": "string"
      }
    ]
  }
}
{
  "type": "object",
  "properties": {
    "resourceId": {
      "format": "uuid",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "resourceName": {
      "type": "string"
    },
    "resourceUrl": {
      "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"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceRegion": {
      "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"
              }
            }
          }
        }
      }
    }
  }
}
<StorageResourcesVM>
  <resourceId>00000000-0000-0000-0000-000000000000</resourceId>
  <resourceName>string</resourceName>
  <resourceUrl>string</resourceUrl>
  <lastModifiedUTC>string</lastModifiedUTC>
  <creationDateTimeUTC>string</creationDateTimeUTC>
  <ownerId>00000000-0000-0000-0000-000000000000</ownerId>
  <resourceType>string</resourceType>
  <resourceRegion>string</resourceRegion>
  <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>
    </tags>
  </metadata>
</StorageResourcesVM>
{
  "type": "object",
  "properties": {
    "resourceId": {
      "format": "uuid",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "resourceName": {
      "type": "string"
    },
    "resourceUrl": {
      "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"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceRegion": {
      "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"
              }
            }
          }
        }
      }
    }
  }
}
<StorageResourcesVM>
  <resourceId>00000000-0000-0000-0000-000000000000</resourceId>
  <resourceName>string</resourceName>
  <resourceUrl>string</resourceUrl>
  <lastModifiedUTC>string</lastModifiedUTC>
  <creationDateTimeUTC>string</creationDateTimeUTC>
  <ownerId>00000000-0000-0000-0000-000000000000</ownerId>
  <resourceType>string</resourceType>
  <resourceRegion>string</resourceRegion>
  <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>
    </tags>
  </metadata>
</StorageResourcesVM>
{
  "type": "object",
  "properties": {
    "resourceId": {
      "format": "uuid",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "resourceName": {
      "type": "string"
    },
    "resourceUrl": {
      "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"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceRegion": {
      "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"
              }
            }
          }
        }
      }
    }
  }
}

400 Bad Request

During the validation none of the users were set as the new Owner of the resource. The reasons can be following: the resource doesn't exist in Veracity system, you don't have the ownership of the resource, you provided the same userId that owns the resource (yourself), provided user doesn't have a role of Data Manager or provided user doesn't exist in the Veracity Identity System

Representations

Code samples

@ECHO OFF

curl -v -X PUT "https://api.veracity.com/veracity/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}?keepAccessAsDataSteward={boolean}"
-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["keepAccessAsDataSteward"] = "{boolean}";
            var uri = "https://api.veracity.com/veracity/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}&" + 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/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}");

            builder.setParameter("keepAccessAsDataSteward", "{boolean}");

            URI uri = builder.build();
            HttpPut request = new HttpPut(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
            "keepAccessAsDataSteward": "{boolean}",
        };
      
        $.ajax({
            url: "https://api.veracity.com/veracity/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                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/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"keepAccessAsDataSteward={boolean}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // 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}/owner?userId={userId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'keepAccessAsDataSteward' => '{boolean}',
);

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

params = urllib.urlencode({
    # Request parameters
    'keepAccessAsDataSteward': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('api.veracity.com')
    conn.request("PUT", "/veracity/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}&%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
    'keepAccessAsDataSteward': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('api.veracity.com')
    conn.request("PUT", "/veracity/datafabric/data/api/1/resources/{resourceId}/owner?userId={userId}&%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}/owner?userId={userId}')

query = URI.encode_www_form({
    # Request parameters
    'keepAccessAsDataSteward' => '{boolean}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Put.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