Provision API

API change history

Copies a given Container with its content with access sharing ID. For successful requests, Returns 202 Accepted without waiting for container create or content copy is finished.

Copies a given Container with its content with access sharing ID. For successful requests, Returns 202 Accepted without waiting for container create or content copy is finished.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. Access Id

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • 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

Values required to copy a container.

{
  "sourceResourceId": "00000000-0000-0000-0000-000000000000",
  "groupId": "00000000-0000-0000-0000-000000000000",
  "copyResourceShortName": "string",
  "copyResourceMayContainPersonalData": true,
  "copyResourceTitle": "string",
  "copyResourceDescription": "string",
  "copyResourceIcon": {
    "id": "string",
    "backgroundColor": "string"
  },
  "copyResourceTags": [
    {
      "title": "string",
      "type": "string"
    }
  ]
}
{
  "description": "An input for provisioning a copy container",
  "required": [
    "sourceResourceId",
    "copyResourceMayContainPersonalData"
  ],
  "type": "object",
  "properties": {
    "sourceResourceId": {
      "format": "uuid",
      "description": "GUID for source resource",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "groupId": {
      "format": "uuid",
      "description": "ID of the group that copy container will be included once it is created.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "copyResourceShortName": {
      "description": "5-32 character short name used to distinguish between storage containers. The name needs to be lowercase and alphanumeric. The full name of the container will comprise of this shortname plus a unique Guid genarated by the system. Note - storage containers can not be renamed",
      "type": "string"
    },
    "copyResourceMayContainPersonalData": {
      "description": "Indicates whether the user has accepted that the container will not contain personal data. Required to be true for a user to upload a container",
      "type": "boolean"
    },
    "copyResourceTitle": {
      "description": "A title of the container",
      "type": "string"
    },
    "copyResourceDescription": {
      "description": "A description of the container",
      "type": "string"
    },
    "copyResourceIcon": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "backgroundColor": {
          "type": "string"
        }
      },
      "description": "An icon of the container"
    },
    "copyResourceTags": {
      "description": "List of container tags",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "sourceResourceId": "00000000-0000-0000-0000-000000000000",
  "groupId": "00000000-0000-0000-0000-000000000000",
  "copyResourceShortName": "string",
  "copyResourceMayContainPersonalData": true,
  "copyResourceTitle": "string",
  "copyResourceDescription": "string",
  "copyResourceIcon": {
    "id": "string",
    "backgroundColor": "string"
  },
  "copyResourceTags": [
    {
      "title": "string",
      "type": "string"
    }
  ]
}
{
  "description": "An input for provisioning a copy container",
  "required": [
    "sourceResourceId",
    "copyResourceMayContainPersonalData"
  ],
  "type": "object",
  "properties": {
    "sourceResourceId": {
      "format": "uuid",
      "description": "GUID for source resource",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "groupId": {
      "format": "uuid",
      "description": "ID of the group that copy container will be included once it is created.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "copyResourceShortName": {
      "description": "5-32 character short name used to distinguish between storage containers. The name needs to be lowercase and alphanumeric. The full name of the container will comprise of this shortname plus a unique Guid genarated by the system. Note - storage containers can not be renamed",
      "type": "string"
    },
    "copyResourceMayContainPersonalData": {
      "description": "Indicates whether the user has accepted that the container will not contain personal data. Required to be true for a user to upload a container",
      "type": "boolean"
    },
    "copyResourceTitle": {
      "description": "A title of the container",
      "type": "string"
    },
    "copyResourceDescription": {
      "description": "A description of the container",
      "type": "string"
    },
    "copyResourceIcon": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "backgroundColor": {
          "type": "string"
        }
      },
      "description": "An icon of the container"
    },
    "copyResourceTags": {
      "description": "List of container tags",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}
<CopyContainerInputVM>
  <sourceResourceId>00000000-0000-0000-0000-000000000000</sourceResourceId>
  <groupId>00000000-0000-0000-0000-000000000000</groupId>
  <copyResourceShortName>string</copyResourceShortName>
  <copyResourceMayContainPersonalData>true</copyResourceMayContainPersonalData>
  <copyResourceTitle>string</copyResourceTitle>
  <copyResourceDescription>string</copyResourceDescription>
  <copyResourceIcon>
    <id>string</id>
    <backgroundColor>string</backgroundColor>
  </copyResourceIcon>
  <copyResourceTags>
    <title>string</title>
    <type>string</type>
  </copyResourceTags>
</CopyContainerInputVM>
{
  "description": "An input for provisioning a copy container",
  "required": [
    "sourceResourceId",
    "copyResourceMayContainPersonalData"
  ],
  "type": "object",
  "properties": {
    "sourceResourceId": {
      "format": "uuid",
      "description": "GUID for source resource",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "groupId": {
      "format": "uuid",
      "description": "ID of the group that copy container will be included once it is created.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "copyResourceShortName": {
      "description": "5-32 character short name used to distinguish between storage containers. The name needs to be lowercase and alphanumeric. The full name of the container will comprise of this shortname plus a unique Guid genarated by the system. Note - storage containers can not be renamed",
      "type": "string"
    },
    "copyResourceMayContainPersonalData": {
      "description": "Indicates whether the user has accepted that the container will not contain personal data. Required to be true for a user to upload a container",
      "type": "boolean"
    },
    "copyResourceTitle": {
      "description": "A title of the container",
      "type": "string"
    },
    "copyResourceDescription": {
      "description": "A description of the container",
      "type": "string"
    },
    "copyResourceIcon": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "backgroundColor": {
          "type": "string"
        }
      },
      "description": "An icon of the container"
    },
    "copyResourceTags": {
      "description": "List of container tags",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}
<CopyContainerInputVM>
  <sourceResourceId>00000000-0000-0000-0000-000000000000</sourceResourceId>
  <groupId>00000000-0000-0000-0000-000000000000</groupId>
  <copyResourceShortName>string</copyResourceShortName>
  <copyResourceMayContainPersonalData>true</copyResourceMayContainPersonalData>
  <copyResourceTitle>string</copyResourceTitle>
  <copyResourceDescription>string</copyResourceDescription>
  <copyResourceIcon>
    <id>string</id>
    <backgroundColor>string</backgroundColor>
  </copyResourceIcon>
  <copyResourceTags>
    <title>string</title>
    <type>string</type>
  </copyResourceTags>
</CopyContainerInputVM>
{
  "description": "An input for provisioning a copy container",
  "required": [
    "sourceResourceId",
    "copyResourceMayContainPersonalData"
  ],
  "type": "object",
  "properties": {
    "sourceResourceId": {
      "format": "uuid",
      "description": "GUID for source resource",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "groupId": {
      "format": "uuid",
      "description": "ID of the group that copy container will be included once it is created.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "copyResourceShortName": {
      "description": "5-32 character short name used to distinguish between storage containers. The name needs to be lowercase and alphanumeric. The full name of the container will comprise of this shortname plus a unique Guid genarated by the system. Note - storage containers can not be renamed",
      "type": "string"
    },
    "copyResourceMayContainPersonalData": {
      "description": "Indicates whether the user has accepted that the container will not contain personal data. Required to be true for a user to upload a container",
      "type": "boolean"
    },
    "copyResourceTitle": {
      "description": "A title of the container",
      "type": "string"
    },
    "copyResourceDescription": {
      "description": "A description of the container",
      "type": "string"
    },
    "copyResourceIcon": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "backgroundColor": {
          "type": "string"
        }
      },
      "description": "An icon of the container"
    },
    "copyResourceTags": {
      "description": "List of container tags",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}

Responses

202 Accepted

Request accepted for processing. Note that provisioning can take up to 15 minutes. Content copy may take longer depends on the size of the container.

400 Bad Request

BadRequest

Code samples

@ECHO OFF

curl -v -X POST "https://api.veracity.com/veracity/datafabric/provisioning/api/1/container/copycontainer?accessId={accessId}"
-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/copycontainer?accessId={accessId}&" + 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.PostAsync(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/provisioning/api/1/container/copycontainer?accessId={accessId}");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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/copycontainer?accessId={accessId}&" + $.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: "POST",
            // 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/copycontainer?accessId={accessId}";
    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:@"POST"];
    // 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/copycontainer?accessId={accessId}');
$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_POST);

// 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("POST", "/veracity/datafabric/provisioning/api/1/container/copycontainer?accessId={accessId}&%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("POST", "/veracity/datafabric/provisioning/api/1/container/copycontainer?accessId={accessId}&%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/copycontainer?accessId={accessId}')


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