Datachain Core API

AllChartController

deleteBulkHdChart

Delete a list of charts


/service/charts

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts?chartsId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllChartControllerApi;

import java.io.File;
import java.util.*;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllChartControllerApi apiInstance = new AllChartControllerApi();
        array[Long] chartsId = ; // array[Long] | Requested chart Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkHdChart(chartsId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#deleteBulkHdChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllChartControllerApi;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        AllChartControllerApi apiInstance = new AllChartControllerApi();
        array[Long] chartsId = ; // array[Long] | Requested chart Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkHdChart(chartsId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#deleteBulkHdChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *chartsId = ; // Requested chart Ids
Long *project = 789; // Project id (optional)

AllChartControllerApi *apiInstance = [[AllChartControllerApi alloc] init];

// Delete a list of charts
[apiInstance deleteBulkHdChartWith:chartsId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllChartControllerApi()
var chartsId = ; // {{array[Long]}} Requested chart Ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBulkHdChart(chartsId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBulkHdChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllChartControllerApi();
            var chartsId = new array[Long](); // array[Long] | Requested chart Ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of charts
                apiInstance.deleteBulkHdChart(chartsId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllChartControllerApi.deleteBulkHdChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllChartControllerApi();
$chartsId = ; // array[Long] | Requested chart Ids
$project = 789; // Long | Project id

try {
    $api_instance->deleteBulkHdChart($chartsId, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllChartControllerApi->deleteBulkHdChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllChartControllerApi->new();
my $chartsId = []; # array[Long] | Requested chart Ids
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBulkHdChart(chartsId => $chartsId, project => $project);
};
if ($@) {
    warn "Exception when calling AllChartControllerApi->deleteBulkHdChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllChartControllerApi()
chartsId =  # array[Long] | Requested chart Ids
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of charts
    api_instance.delete_bulk_hd_chart(chartsId, project=project)
except ApiException as e:
    print("Exception when calling AllChartControllerApi->deleteBulkHdChart: %s\n" % e)

Parameters

Query parameters
Name Description
chartsId*
array[Long] (int64)
Requested chart Ids
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


getAllHdCharts

Get a list of all available charts


/service/charts

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllChartControllerApi;

import java.io.File;
import java.util.*;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllChartControllerApi apiInstance = new AllChartControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdChart] result = apiInstance.getAllHdCharts(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#getAllHdCharts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllChartControllerApi;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        AllChartControllerApi apiInstance = new AllChartControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdChart] result = apiInstance.getAllHdCharts(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#getAllHdCharts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

AllChartControllerApi *apiInstance = [[AllChartControllerApi alloc] init];

// Get a list of all available charts
[apiInstance getAllHdChartsWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[HdChart] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllChartControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllHdCharts(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllHdChartsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllChartControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of all available charts
                array[HdChart] result = apiInstance.getAllHdCharts(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllChartControllerApi.getAllHdCharts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllChartControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllHdCharts($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllChartControllerApi->getAllHdCharts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllChartControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllHdCharts(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllChartControllerApi->getAllHdCharts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllChartControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of all available charts
    api_response = api_instance.get_all_hd_charts(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllChartControllerApi->getAllHdCharts: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getChartsElementsForMove

Get chart linked element for move/copy


/service/charts/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllChartControllerApi;

import java.io.File;
import java.util.*;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllChartControllerApi apiInstance = new AllChartControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Chart ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getChartsElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#getChartsElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllChartControllerApi;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        AllChartControllerApi apiInstance = new AllChartControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Chart ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getChartsElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#getChartsElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Chart ID (optional)
Long *project = 789; // Project id (optional)

AllChartControllerApi *apiInstance = [[AllChartControllerApi alloc] init];

// Get chart linked element for move/copy
[apiInstance getChartsElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllChartControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Chart ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChartsElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getChartsElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllChartControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Chart ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get chart linked element for move/copy
                array[DcUsedElement] result = apiInstance.getChartsElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllChartControllerApi.getChartsElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllChartControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Chart ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getChartsElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllChartControllerApi->getChartsElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllChartControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Chart ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getChartsElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllChartControllerApi->getChartsElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllChartControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Chart ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get chart linked element for move/copy
    api_response = api_instance.get_charts_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllChartControllerApi->getChartsElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Chart ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveChartsElements

Move chart and linked elements to another project


/service/charts/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllChartControllerApi;

import java.io.File;
import java.util.*;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllChartControllerApi apiInstance = new AllChartControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Chart ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveChartsElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#moveChartsElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllChartControllerApi;

public class AllChartControllerApiExample {

    public static void main(String[] args) {
        AllChartControllerApi apiInstance = new AllChartControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Chart ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveChartsElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllChartControllerApi#moveChartsElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Chart ID (optional)
Long *project = 789; // Project id (optional)

AllChartControllerApi *apiInstance = [[AllChartControllerApi alloc] init];

// Move chart and linked elements to another project
[apiInstance moveChartsElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllChartControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Chart ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveChartsElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveChartsElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllChartControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Chart ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move chart and linked elements to another project
                DcMoveResponse result = apiInstance.moveChartsElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllChartControllerApi.moveChartsElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllChartControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Chart ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveChartsElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllChartControllerApi->moveChartsElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllChartControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Chart ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveChartsElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllChartControllerApi->moveChartsElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllChartControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Chart ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move chart and linked elements to another project
    api_response = api_instance.move_charts_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllChartControllerApi->moveChartsElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Chart ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


AllDepotController

deleteManyDepots

Delete a list of depots


/service/depots

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots?ctx=&depotsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        array[Long] depotsIds = ; // array[Long] | depotsIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyDepots(ctx, depotsIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#deleteManyDepots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        array[Long] depotsIds = ; // array[Long] | depotsIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyDepots(ctx, depotsIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#deleteManyDepots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
array[Long] *depotsIds = ; // depotsIds
Long *project = 789; // Project id (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// Delete a list of depots
[apiInstance deleteManyDepotsWith:ctx
    depotsIds:depotsIds
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotsIds = ; // {{array[Long]}} depotsIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteManyDepots(ctx, depotsIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteManyDepotsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotsIds = new array[Long](); // array[Long] | depotsIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of depots
                apiInstance.deleteManyDepots(ctx, depotsIds, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.deleteManyDepots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotsIds = ; // array[Long] | depotsIds
$project = 789; // Long | Project id

try {
    $api_instance->deleteManyDepots($ctx, $depotsIds, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->deleteManyDepots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotsIds = []; # array[Long] | depotsIds
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteManyDepots(ctx => $ctx, depotsIds => $depotsIds, project => $project);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->deleteManyDepots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
ctx = 56 # Integer | ctx
depotsIds =  # array[Long] | depotsIds
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of depots
    api_instance.delete_many_depots(ctx, depotsIds, project=project)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->deleteManyDepots: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotsIds*
array[Long] (int64)
depotsIds
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllDepots

View a list of depots


/service/depots

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots?details=&excludeInactive=&excludePublic=&excludedTypes=&includedTypes=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Boolean details = true; // Boolean | Return the metadata object if True, the label and the code only if false
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        array[String] excludedTypes = ; // array[String] | Exclude connectors which the type is present in this list
        array[String] includedTypes = ; // array[String] | Include connectors which the type is present in this list
        Long project = 789; // Long | Project id
        try {
            array[Depot] result = apiInstance.findAllDepots(details, excludeInactive, excludePublic, excludedTypes, includedTypes, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#findAllDepots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Boolean details = true; // Boolean | Return the metadata object if True, the label and the code only if false
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        array[String] excludedTypes = ; // array[String] | Exclude connectors which the type is present in this list
        array[String] includedTypes = ; // array[String] | Include connectors which the type is present in this list
        Long project = 789; // Long | Project id
        try {
            array[Depot] result = apiInstance.findAllDepots(details, excludeInactive, excludePublic, excludedTypes, includedTypes, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#findAllDepots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *details = true; // Return the metadata object if True, the label and the code only if false (optional)
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
array[String] *excludedTypes = ; // Exclude connectors which the type is present in this list (optional)
array[String] *includedTypes = ; // Include connectors which the type is present in this list (optional)
Long *project = 789; // Project id (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// View a list of depots
[apiInstance findAllDepotsWith:details
    excludeInactive:excludeInactive
    excludePublic:excludePublic
    excludedTypes:excludedTypes
    includedTypes:includedTypes
    project:project
              completionHandler: ^(array[Depot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var opts = { 
  'details': true, // {{Boolean}} Return the metadata object if True, the label and the code only if false
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'excludedTypes': , // {{array[String]}} Exclude connectors which the type is present in this list
  'includedTypes': , // {{array[String]}} Include connectors which the type is present in this list
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllDepots(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllDepotsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var details = true;  // Boolean | Return the metadata object if True, the label and the code only if false (optional) 
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var excludedTypes = new array[String](); // array[String] | Exclude connectors which the type is present in this list (optional) 
            var includedTypes = new array[String](); // array[String] | Include connectors which the type is present in this list (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of depots
                array[Depot] result = apiInstance.findAllDepots(details, excludeInactive, excludePublic, excludedTypes, includedTypes, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.findAllDepots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$details = true; // Boolean | Return the metadata object if True, the label and the code only if false
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$excludedTypes = ; // array[String] | Exclude connectors which the type is present in this list
$includedTypes = ; // array[String] | Include connectors which the type is present in this list
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllDepots($details, $excludeInactive, $excludePublic, $excludedTypes, $includedTypes, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->findAllDepots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $details = true; # Boolean | Return the metadata object if True, the label and the code only if false
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $excludedTypes = []; # array[String] | Exclude connectors which the type is present in this list
my $includedTypes = []; # array[String] | Include connectors which the type is present in this list
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllDepots(details => $details, excludeInactive => $excludeInactive, excludePublic => $excludePublic, excludedTypes => $excludedTypes, includedTypes => $includedTypes, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->findAllDepots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
details = true # Boolean | Return the metadata object if True, the label and the code only if false (optional)
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
excludedTypes =  # array[String] | Exclude connectors which the type is present in this list (optional)
includedTypes =  # array[String] | Include connectors which the type is present in this list (optional)
project = 789 # Long | Project id (optional)

try: 
    # View a list of depots
    api_response = api_instance.find_all_depots(details=details, excludeInactive=excludeInactive, excludePublic=excludePublic, excludedTypes=excludedTypes, includedTypes=includedTypes, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->findAllDepots: %s\n" % e)

Parameters

Query parameters
Name Description
details
Boolean
Return the metadata object if True, the label and the code only if false
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
excludedTypes
array[String]
Exclude connectors which the type is present in this list
includedTypes
array[String]
Include connectors which the type is present in this list
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findDepotsByConnectorId

Get a list of depot for a given connector


/service/depots/by_connector_id

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/by_connector_id?connectorId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            array[Depot] result = apiInstance.findDepotsByConnectorId(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#findDepotsByConnectorId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            array[Depot] result = apiInstance.findDepotsByConnectorId(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#findDepotsByConnectorId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// Get a list of depot for a given connector
[apiInstance findDepotsByConnectorIdWith:connectorId
    project:project
              completionHandler: ^(array[Depot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDepotsByConnectorId(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDepotsByConnectorIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of depot for a given connector
                array[Depot] result = apiInstance.findDepotsByConnectorId(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.findDepotsByConnectorId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findDepotsByConnectorId($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->findDepotsByConnectorId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findDepotsByConnectorId(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->findDepotsByConnectorId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Get a list of depot for a given connector
    api_response = api_instance.find_depots_by_connector_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->findDepotsByConnectorId: %s\n" % e)

Parameters

Query parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneDepotById

Get a depot by id


/service/depots/all/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/all/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Depot result = apiInstance.findOneDepotById(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#findOneDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Depot result = apiInstance.findOneDepotById(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#findOneDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// Get a depot by id
[apiInstance findOneDepotByIdWith:depotId
    project:project
              completionHandler: ^(Depot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a depot by id
                Depot result = apiInstance.findOneDepotById(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.findOneDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneDepotById($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->findOneDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneDepotById(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->findOneDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get a depot by id
    api_response = api_instance.find_one_depot_by_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->findOneDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDepotElementsForMove

Get depot linked element for move/copy


/service/depots/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Depot ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getDepotElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#getDepotElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Depot ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getDepotElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#getDepotElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Depot ID (optional)
Long *project = 789; // Project id (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// Get depot linked element for move/copy
[apiInstance getDepotElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Depot ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDepotElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDepotElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Depot ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get depot linked element for move/copy
                array[DcUsedElement] result = apiInstance.getDepotElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.getDepotElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Depot ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDepotElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->getDepotElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Depot ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDepotElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->getDepotElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Depot ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get depot linked element for move/copy
    api_response = api_instance.get_depot_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->getDepotElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Depot ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersReferencingModes

Get depot headers referencing modes


/service/depots/all/referencing_modes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/all/referencing_modes?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[HeadersReferencingMode] result = apiInstance.getHeadersReferencingModes(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#getHeadersReferencingModes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[HeadersReferencingMode] result = apiInstance.getHeadersReferencingModes(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#getHeadersReferencingModes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// Get depot headers referencing modes
[apiInstance getHeadersReferencingModesWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[HeadersReferencingMode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersReferencingModes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersReferencingModesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get depot headers referencing modes
                array[HeadersReferencingMode] result = apiInstance.getHeadersReferencingModes(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.getHeadersReferencingModes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getHeadersReferencingModes($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->getHeadersReferencingModes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getHeadersReferencingModes(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->getHeadersReferencingModes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get depot headers referencing modes
    api_response = api_instance.get_headers_referencing_modes(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->getHeadersReferencingModes: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveDepotElements

Move depot and linked elements to another project


/service/depots/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllDepotControllerApi;

import java.io.File;
import java.util.*;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Depot ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveDepotElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#moveDepotElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllDepotControllerApi;

public class AllDepotControllerApiExample {

    public static void main(String[] args) {
        AllDepotControllerApi apiInstance = new AllDepotControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Depot ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveDepotElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllDepotControllerApi#moveDepotElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Depot ID (optional)
Long *project = 789; // Project id (optional)

AllDepotControllerApi *apiInstance = [[AllDepotControllerApi alloc] init];

// Move depot and linked elements to another project
[apiInstance moveDepotElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllDepotControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Depot ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveDepotElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveDepotElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllDepotControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Depot ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move depot and linked elements to another project
                DcMoveResponse result = apiInstance.moveDepotElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllDepotControllerApi.moveDepotElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllDepotControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Depot ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveDepotElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllDepotControllerApi->moveDepotElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllDepotControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Depot ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveDepotElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllDepotControllerApi->moveDepotElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllDepotControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Depot ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move depot and linked elements to another project
    api_response = api_instance.move_depot_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllDepotControllerApi->moveDepotElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Depot ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


AllGridController

deleteBulkGridUsingDELETE

Delete a list of grids


/service/grids

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/grids?gridsId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllGridControllerApi;

import java.io.File;
import java.util.*;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllGridControllerApi apiInstance = new AllGridControllerApi();
        array[Long] gridsId = ; // array[Long] | Requested grid Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkGridUsingDELETE(gridsId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#deleteBulkGridUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllGridControllerApi;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        AllGridControllerApi apiInstance = new AllGridControllerApi();
        array[Long] gridsId = ; // array[Long] | Requested grid Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkGridUsingDELETE(gridsId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#deleteBulkGridUsingDELETE");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *gridsId = ; // Requested grid Ids
Long *project = 789; // Project id (optional)

AllGridControllerApi *apiInstance = [[AllGridControllerApi alloc] init];

// Delete a list of grids
[apiInstance deleteBulkGridUsingDELETEWith:gridsId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllGridControllerApi()
var gridsId = ; // {{array[Long]}} Requested grid Ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBulkGridUsingDELETE(gridsId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBulkGridUsingDELETEExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllGridControllerApi();
            var gridsId = new array[Long](); // array[Long] | Requested grid Ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of grids
                apiInstance.deleteBulkGridUsingDELETE(gridsId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllGridControllerApi.deleteBulkGridUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllGridControllerApi();
$gridsId = ; // array[Long] | Requested grid Ids
$project = 789; // Long | Project id

try {
    $api_instance->deleteBulkGridUsingDELETE($gridsId, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllGridControllerApi->deleteBulkGridUsingDELETE: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllGridControllerApi->new();
my $gridsId = []; # array[Long] | Requested grid Ids
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBulkGridUsingDELETE(gridsId => $gridsId, project => $project);
};
if ($@) {
    warn "Exception when calling AllGridControllerApi->deleteBulkGridUsingDELETE: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllGridControllerApi()
gridsId =  # array[Long] | Requested grid Ids
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of grids
    api_instance.delete_bulk_grid_using_delete(gridsId, project=project)
except ApiException as e:
    print("Exception when calling AllGridControllerApi->deleteBulkGridUsingDELETE: %s\n" % e)

Parameters

Query parameters
Name Description
gridsId*
array[Long] (int64)
Requested grid Ids
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


getAllUsingGET

Get a list of all available grids


/service/grids

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllGridControllerApi;

import java.io.File;
import java.util.*;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllGridControllerApi apiInstance = new AllGridControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdGrid] result = apiInstance.getAllUsingGET(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#getAllUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllGridControllerApi;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        AllGridControllerApi apiInstance = new AllGridControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdGrid] result = apiInstance.getAllUsingGET(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#getAllUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

AllGridControllerApi *apiInstance = [[AllGridControllerApi alloc] init];

// Get a list of all available grids
[apiInstance getAllUsingGETWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[HdGrid] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllGridControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllUsingGET(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllGridControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of all available grids
                array[HdGrid] result = apiInstance.getAllUsingGET(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllGridControllerApi.getAllUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllGridControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllUsingGET($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllGridControllerApi->getAllUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllGridControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllUsingGET(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllGridControllerApi->getAllUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllGridControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of all available grids
    api_response = api_instance.get_all_using_get(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllGridControllerApi->getAllUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getGridElementsForMove

Get grids linked element for move/copy


/service/grids/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllGridControllerApi;

import java.io.File;
import java.util.*;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllGridControllerApi apiInstance = new AllGridControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Grid ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getGridElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#getGridElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllGridControllerApi;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        AllGridControllerApi apiInstance = new AllGridControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Grid ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getGridElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#getGridElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Grid ID (optional)
Long *project = 789; // Project id (optional)

AllGridControllerApi *apiInstance = [[AllGridControllerApi alloc] init];

// Get grids linked element for move/copy
[apiInstance getGridElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllGridControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Grid ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGridElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGridElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllGridControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Grid ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get grids linked element for move/copy
                array[DcUsedElement] result = apiInstance.getGridElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllGridControllerApi.getGridElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllGridControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Grid ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGridElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllGridControllerApi->getGridElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllGridControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Grid ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGridElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllGridControllerApi->getGridElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllGridControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Grid ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get grids linked element for move/copy
    api_response = api_instance.get_grid_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllGridControllerApi->getGridElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Grid ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveGridElements

Move Grid and linked elements to another project


/service/grids/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllGridControllerApi;

import java.io.File;
import java.util.*;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllGridControllerApi apiInstance = new AllGridControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Grid ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveGridElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#moveGridElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllGridControllerApi;

public class AllGridControllerApiExample {

    public static void main(String[] args) {
        AllGridControllerApi apiInstance = new AllGridControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Grid ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveGridElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllGridControllerApi#moveGridElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Grid ID (optional)
Long *project = 789; // Project id (optional)

AllGridControllerApi *apiInstance = [[AllGridControllerApi alloc] init];

// Move Grid and linked elements to another project
[apiInstance moveGridElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllGridControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Grid ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveGridElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveGridElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllGridControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Grid ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move Grid and linked elements to another project
                DcMoveResponse result = apiInstance.moveGridElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllGridControllerApi.moveGridElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllGridControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Grid ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveGridElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllGridControllerApi->moveGridElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllGridControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Grid ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveGridElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllGridControllerApi->moveGridElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllGridControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Grid ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move Grid and linked elements to another project
    api_response = api_instance.move_grid_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllGridControllerApi->moveGridElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Grid ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


AllMediaController

createMediaItem

Create a media item


/service/medias/{id}/items

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/{id}/items?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        MediaItemEntry body = ; // MediaItemEntry | mediaItemEntry
        Long id = 789; // Long | Media Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.createMediaItem(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#createMediaItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        MediaItemEntry body = ; // MediaItemEntry | mediaItemEntry
        Long id = 789; // Long | Media Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.createMediaItem(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#createMediaItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MediaItemEntry *body = ; // mediaItemEntry
Long *id = 789; // Media Id
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Create a media item
[apiInstance createMediaItemWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var body = ; // {{MediaItemEntry}} mediaItemEntry
var id = 789; // {{Long}} Media Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createMediaItem(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMediaItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var body = new MediaItemEntry(); // MediaItemEntry | mediaItemEntry
            var id = 789;  // Long | Media Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a media item
                apiInstance.createMediaItem(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.createMediaItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$body = ; // MediaItemEntry | mediaItemEntry
$id = 789; // Long | Media Id
$project = 789; // Long | Project id

try {
    $api_instance->createMediaItem($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->createMediaItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::MediaItemEntry->new(); # MediaItemEntry | mediaItemEntry
my $id = 789; # Long | Media Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->createMediaItem(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->createMediaItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
body =  # MediaItemEntry | mediaItemEntry
id = 789 # Long | Media Id
project = 789 # Long | Project id (optional)

try: 
    # Create a media item
    api_instance.create_media_item(body, id, project=project)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->createMediaItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Media Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createUploadedMediaItem

Create a media item with upload


/service/medias/{id}/items/uploaded

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"//localhost:80//service/medias/{id}/items/uploaded"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Media Id
         project = ; //  | 
        try {
            apiInstance.createUploadedMediaItem(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#createUploadedMediaItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Media Id
         project = ; //  | 
        try {
            apiInstance.createUploadedMediaItem(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#createUploadedMediaItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Media Id
 *project = ; //  (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Create a media item with upload
[apiInstance createUploadedMediaItemWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var id = 789; // {{Long}} Media Id
var opts = { 
  'project':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUploadedMediaItem(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUploadedMediaItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var id = 789;  // Long | Media Id
            var project = new (); //  |  (optional) 

            try
            {
                // Create a media item with upload
                apiInstance.createUploadedMediaItem(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.createUploadedMediaItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$id = 789; // Long | Media Id
$project = ; //  | 

try {
    $api_instance->createUploadedMediaItem($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->createUploadedMediaItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $id = 789; # Long | Media Id
my $project = ; #  | 

eval { 
    $api_instance->createUploadedMediaItem(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->createUploadedMediaItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
id = 789 # Long | Media Id
project =  #  |  (optional)

try: 
    # Create a media item with upload
    api_instance.create_uploaded_media_item(id, project=project)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->createUploadedMediaItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Media Id
Required
Form parameters
Name Description
project

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteBulkHdMedia

Delete a list of medias


/service/medias

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/medias?mediasId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        array[Long] mediasId = ; // array[Long] | Requested media Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkHdMedia(mediasId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#deleteBulkHdMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        array[Long] mediasId = ; // array[Long] | Requested media Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkHdMedia(mediasId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#deleteBulkHdMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *mediasId = ; // Requested media Ids
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Delete a list of medias
[apiInstance deleteBulkHdMediaWith:mediasId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var mediasId = ; // {{array[Long]}} Requested media Ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBulkHdMedia(mediasId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBulkHdMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var mediasId = new array[Long](); // array[Long] | Requested media Ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of medias
                apiInstance.deleteBulkHdMedia(mediasId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.deleteBulkHdMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$mediasId = ; // array[Long] | Requested media Ids
$project = 789; // Long | Project id

try {
    $api_instance->deleteBulkHdMedia($mediasId, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->deleteBulkHdMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $mediasId = []; # array[Long] | Requested media Ids
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBulkHdMedia(mediasId => $mediasId, project => $project);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->deleteBulkHdMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
mediasId =  # array[Long] | Requested media Ids
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of medias
    api_instance.delete_bulk_hd_media(mediasId, project=project)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->deleteBulkHdMedia: %s\n" % e)

Parameters

Query parameters
Name Description
mediasId*
array[Long] (int64)
Requested media Ids
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteMediaItem

Delete a media item


/service/medias/{id}/items/{itemId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/medias/{id}/items/{itemId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Media Id
        Long itemId = 789; // Long | Item Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMediaItem(id, itemId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#deleteMediaItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Media Id
        Long itemId = 789; // Long | Item Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMediaItem(id, itemId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#deleteMediaItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Media Id
Long *itemId = 789; // Item Id
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Delete a media item
[apiInstance deleteMediaItemWith:id
    itemId:itemId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var id = 789; // {{Long}} Media Id
var itemId = 789; // {{Long}} Item Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMediaItem(id, itemId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMediaItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var id = 789;  // Long | Media Id
            var itemId = 789;  // Long | Item Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a media item
                apiInstance.deleteMediaItem(id, itemId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.deleteMediaItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$id = 789; // Long | Media Id
$itemId = 789; // Long | Item Id
$project = 789; // Long | Project id

try {
    $api_instance->deleteMediaItem($id, $itemId, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->deleteMediaItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $id = 789; # Long | Media Id
my $itemId = 789; # Long | Item Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteMediaItem(id => $id, itemId => $itemId, project => $project);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->deleteMediaItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
id = 789 # Long | Media Id
itemId = 789 # Long | Item Id
project = 789 # Long | Project id (optional)

try: 
    # Delete a media item
    api_instance.delete_media_item(id, itemId, project=project)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->deleteMediaItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Media Id
Required
itemId*
Long (int64)
Item Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


downloadMediaFile

Download a media file


/service/medias/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        String token = token_example; // String | Token du media
        try {
            InputStreamResource result = apiInstance.downloadMediaFile(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#downloadMediaFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        String token = token_example; // String | Token du media
        try {
            InputStreamResource result = apiInstance.downloadMediaFile(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#downloadMediaFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // Token du media (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Download a media file
[apiInstance downloadMediaFileWith:token
              completionHandler: ^(InputStreamResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var opts = { 
  'token': token_example // {{String}} Token du media
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadMediaFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadMediaFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var token = token_example;  // String | Token du media (optional) 

            try
            {
                // Download a media file
                InputStreamResource result = apiInstance.downloadMediaFile(token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.downloadMediaFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$token = token_example; // String | Token du media

try {
    $result = $api_instance->downloadMediaFile($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->downloadMediaFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $token = token_example; # String | Token du media

eval { 
    my $result = $api_instance->downloadMediaFile(token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->downloadMediaFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
token = token_example # String | Token du media (optional)

try: 
    # Download a media file
    api_response = api_instance.download_media_file(token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->downloadMediaFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
Token du media

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


downloadMediaFileToken

get Download media file token


/service/medias/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/token?mediaItemId=&mediasId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long mediaItemId = 789; // Long | Media Item Id
        Long mediasId = 789; // Long | Media Id
        try {
            'String' result = apiInstance.downloadMediaFileToken(mediaItemId, mediasId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#downloadMediaFileToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long mediaItemId = 789; // Long | Media Item Id
        Long mediasId = 789; // Long | Media Id
        try {
            'String' result = apiInstance.downloadMediaFileToken(mediaItemId, mediasId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#downloadMediaFileToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *mediaItemId = 789; // Media Item Id (optional)
Long *mediasId = 789; // Media Id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// get Download media file token
[apiInstance downloadMediaFileTokenWith:mediaItemId
    mediasId:mediasId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var opts = { 
  'mediaItemId': 789, // {{Long}} Media Item Id
  'mediasId': 789 // {{Long}} Media Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadMediaFileToken(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadMediaFileTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var mediaItemId = 789;  // Long | Media Item Id (optional) 
            var mediasId = 789;  // Long | Media Id (optional) 

            try
            {
                // get Download media file token
                'String' result = apiInstance.downloadMediaFileToken(mediaItemId, mediasId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.downloadMediaFileToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$mediaItemId = 789; // Long | Media Item Id
$mediasId = 789; // Long | Media Id

try {
    $result = $api_instance->downloadMediaFileToken($mediaItemId, $mediasId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->downloadMediaFileToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $mediaItemId = 789; # Long | Media Item Id
my $mediasId = 789; # Long | Media Id

eval { 
    my $result = $api_instance->downloadMediaFileToken(mediaItemId => $mediaItemId, mediasId => $mediasId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->downloadMediaFileToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
mediaItemId = 789 # Long | Media Item Id (optional)
mediasId = 789 # Long | Media Id (optional)

try: 
    # get Download media file token
    api_response = api_instance.download_media_file_token(mediaItemId=mediaItemId, mediasId=mediasId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->downloadMediaFileToken: %s\n" % e)

Parameters

Query parameters
Name Description
mediaItemId
Long (int64)
Media Item Id
mediasId
Long (int64)
Media Id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


downloadPublishedMediaFile

Download a published media file


/service/dashboard_publication/medias/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboard_publication/medias/download?link=&mediaItemId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        String link = link_example; // String | link
        Long mediaItemId = 789; // Long | Media Item Id
        try {
            InputStreamResource result = apiInstance.downloadPublishedMediaFile(link, mediaItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#downloadPublishedMediaFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        String link = link_example; // String | link
        Long mediaItemId = 789; // Long | Media Item Id
        try {
            InputStreamResource result = apiInstance.downloadPublishedMediaFile(link, mediaItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#downloadPublishedMediaFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *link = link_example; // link
Long *mediaItemId = 789; // Media Item Id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Download a published media file
[apiInstance downloadPublishedMediaFileWith:link
    mediaItemId:mediaItemId
              completionHandler: ^(InputStreamResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var link = link_example; // {{String}} link
var opts = { 
  'mediaItemId': 789 // {{Long}} Media Item Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadPublishedMediaFile(link, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadPublishedMediaFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var link = link_example;  // String | link
            var mediaItemId = 789;  // Long | Media Item Id (optional) 

            try
            {
                // Download a published media file
                InputStreamResource result = apiInstance.downloadPublishedMediaFile(link, mediaItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.downloadPublishedMediaFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$link = link_example; // String | link
$mediaItemId = 789; // Long | Media Item Id

try {
    $result = $api_instance->downloadPublishedMediaFile($link, $mediaItemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->downloadPublishedMediaFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $link = link_example; # String | link
my $mediaItemId = 789; # Long | Media Item Id

eval { 
    my $result = $api_instance->downloadPublishedMediaFile(link => $link, mediaItemId => $mediaItemId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->downloadPublishedMediaFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
link = link_example # String | link
mediaItemId = 789 # Long | Media Item Id (optional)

try: 
    # Download a published media file
    api_response = api_instance.download_published_media_file(link, mediaItemId=mediaItemId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->downloadPublishedMediaFile: %s\n" % e)

Parameters

Query parameters
Name Description
link*
mediaItemId
Long (int64)
Media Item Id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getAllHdMedias

Get a list of all available medias


/service/medias

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdMedia] result = apiInstance.getAllHdMedias(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#getAllHdMedias");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdMedia] result = apiInstance.getAllHdMedias(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#getAllHdMedias");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Get a list of all available medias
[apiInstance getAllHdMediasWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[HdMedia] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllHdMedias(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllHdMediasExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of all available medias
                array[HdMedia] result = apiInstance.getAllHdMedias(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.getAllHdMedias: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllHdMedias($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->getAllHdMedias: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllHdMedias(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->getAllHdMedias: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of all available medias
    api_response = api_instance.get_all_hd_medias(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->getAllHdMedias: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getAllMediaItems

Get a list of media items


/service/medias/{id}/items

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/{id}/items?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Requested media Id
        Long project = 789; // Long | Project id
        try {
            array[MediaItem] result = apiInstance.getAllMediaItems(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#getAllMediaItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Requested media Id
        Long project = 789; // Long | Project id
        try {
            array[MediaItem] result = apiInstance.getAllMediaItems(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#getAllMediaItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested media Id
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Get a list of media items
[apiInstance getAllMediaItemsWith:id
    project:project
              completionHandler: ^(array[MediaItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var id = 789; // {{Long}} Requested media Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllMediaItems(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllMediaItemsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var id = 789;  // Long | Requested media Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of media items
                array[MediaItem] result = apiInstance.getAllMediaItems(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.getAllMediaItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$id = 789; // Long | Requested media Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllMediaItems($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->getAllMediaItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $id = 789; # Long | Requested media Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllMediaItems(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->getAllMediaItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
id = 789 # Long | Requested media Id
project = 789 # Long | Project id (optional)

try: 
    # Get a list of media items
    api_response = api_instance.get_all_media_items(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->getAllMediaItems: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested media Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMediaElementsForMove

Get medias linked element for move/copy


/service/medias/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Media ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getMediaElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#getMediaElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Media ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getMediaElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#getMediaElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Media ID (optional)
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Get medias linked element for move/copy
[apiInstance getMediaElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Media ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMediaElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Media ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get medias linked element for move/copy
                array[DcUsedElement] result = apiInstance.getMediaElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.getMediaElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Media ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMediaElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->getMediaElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Media ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMediaElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->getMediaElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Media ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get medias linked element for move/copy
    api_response = api_instance.get_media_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->getMediaElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Media ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveMediaElements

Move Media and linked elements to another project


/service/medias/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Media ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveMediaElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#moveMediaElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Media ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveMediaElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#moveMediaElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Media ID (optional)
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Move Media and linked elements to another project
[apiInstance moveMediaElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Media ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveMediaElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveMediaElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Media ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move Media and linked elements to another project
                DcMoveResponse result = apiInstance.moveMediaElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.moveMediaElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Media ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveMediaElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->moveMediaElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Media ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveMediaElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->moveMediaElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Media ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move Media and linked elements to another project
    api_response = api_instance.move_media_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->moveMediaElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Media ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateMediaItem

Update a media item


/service/medias/{id}/items/{itemId}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/{id}/items/{itemId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        MediaItemEntry body = ; // MediaItemEntry | mediaItemEntry
        Long id = 789; // Long | Media Id
        Long itemId = 789; // Long | Item Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateMediaItem(body, id, itemId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#updateMediaItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        MediaItemEntry body = ; // MediaItemEntry | mediaItemEntry
        Long id = 789; // Long | Media Id
        Long itemId = 789; // Long | Item Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateMediaItem(body, id, itemId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#updateMediaItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MediaItemEntry *body = ; // mediaItemEntry
Long *id = 789; // Media Id
Long *itemId = 789; // Item Id
Long *project = 789; // Project id (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Update a media item
[apiInstance updateMediaItemWith:body
    id:id
    itemId:itemId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var body = ; // {{MediaItemEntry}} mediaItemEntry
var id = 789; // {{Long}} Media Id
var itemId = 789; // {{Long}} Item Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateMediaItem(bodyiditemId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMediaItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var body = new MediaItemEntry(); // MediaItemEntry | mediaItemEntry
            var id = 789;  // Long | Media Id
            var itemId = 789;  // Long | Item Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update a media item
                apiInstance.updateMediaItem(body, id, itemId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.updateMediaItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$body = ; // MediaItemEntry | mediaItemEntry
$id = 789; // Long | Media Id
$itemId = 789; // Long | Item Id
$project = 789; // Long | Project id

try {
    $api_instance->updateMediaItem($body, $id, $itemId, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->updateMediaItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::MediaItemEntry->new(); # MediaItemEntry | mediaItemEntry
my $id = 789; # Long | Media Id
my $itemId = 789; # Long | Item Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateMediaItem(body => $body, id => $id, itemId => $itemId, project => $project);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->updateMediaItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
body =  # MediaItemEntry | mediaItemEntry
id = 789 # Long | Media Id
itemId = 789 # Long | Item Id
project = 789 # Long | Project id (optional)

try: 
    # Update a media item
    api_instance.update_media_item(body, id, itemId, project=project)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->updateMediaItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Media Id
Required
itemId*
Long (int64)
Item Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateUploadedMediaItem

Update a media item with upload


/service/medias/{id}/items/uploaded/{itemId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"//localhost:80//service/medias/{id}/items/uploaded/{itemId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AllMediaControllerApi;

import java.io.File;
import java.util.*;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Media Id
        Long itemId = 789; // Long | Item Id
         project = ; //  | 
        try {
            apiInstance.updateUploadedMediaItem(id, itemId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#updateUploadedMediaItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AllMediaControllerApi;

public class AllMediaControllerApiExample {

    public static void main(String[] args) {
        AllMediaControllerApi apiInstance = new AllMediaControllerApi();
        Long id = 789; // Long | Media Id
        Long itemId = 789; // Long | Item Id
         project = ; //  | 
        try {
            apiInstance.updateUploadedMediaItem(id, itemId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllMediaControllerApi#updateUploadedMediaItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Media Id
Long *itemId = 789; // Item Id
 *project = ; //  (optional)

AllMediaControllerApi *apiInstance = [[AllMediaControllerApi alloc] init];

// Update a media item with upload
[apiInstance updateUploadedMediaItemWith:id
    itemId:itemId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AllMediaControllerApi()
var id = 789; // {{Long}} Media Id
var itemId = 789; // {{Long}} Item Id
var opts = { 
  'project':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUploadedMediaItem(iditemId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUploadedMediaItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AllMediaControllerApi();
            var id = 789;  // Long | Media Id
            var itemId = 789;  // Long | Item Id
            var project = new (); //  |  (optional) 

            try
            {
                // Update a media item with upload
                apiInstance.updateUploadedMediaItem(id, itemId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AllMediaControllerApi.updateUploadedMediaItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAllMediaControllerApi();
$id = 789; // Long | Media Id
$itemId = 789; // Long | Item Id
$project = ; //  | 

try {
    $api_instance->updateUploadedMediaItem($id, $itemId, $project);
} catch (Exception $e) {
    echo 'Exception when calling AllMediaControllerApi->updateUploadedMediaItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AllMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AllMediaControllerApi->new();
my $id = 789; # Long | Media Id
my $itemId = 789; # Long | Item Id
my $project = ; #  | 

eval { 
    $api_instance->updateUploadedMediaItem(id => $id, itemId => $itemId, project => $project);
};
if ($@) {
    warn "Exception when calling AllMediaControllerApi->updateUploadedMediaItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AllMediaControllerApi()
id = 789 # Long | Media Id
itemId = 789 # Long | Item Id
project =  #  |  (optional)

try: 
    # Update a media item with upload
    api_instance.update_uploaded_media_item(id, itemId, project=project)
except ApiException as e:
    print("Exception when calling AllMediaControllerApi->updateUploadedMediaItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Media Id
Required
itemId*
Long (int64)
Item Id
Required
Form parameters
Name Description
project

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


AutoDocController

generateDBOrEntityDoc

Generate Business Entity / DataBlock documentation


/service/auto_doc/{elementId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/auto_doc/{elementId}?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutoDocControllerApi;

import java.io.File;
import java.util.*;

public class AutoDocControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        AutoDocControllerApi apiInstance = new AutoDocControllerApi();
        Long elementId = 789; // Long | elementId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.generateDBOrEntityDoc(elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutoDocControllerApi#generateDBOrEntityDoc");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutoDocControllerApi;

public class AutoDocControllerApiExample {

    public static void main(String[] args) {
        AutoDocControllerApi apiInstance = new AutoDocControllerApi();
        Long elementId = 789; // Long | elementId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.generateDBOrEntityDoc(elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutoDocControllerApi#generateDBOrEntityDoc");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *elementId = 789; // elementId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

AutoDocControllerApi *apiInstance = [[AutoDocControllerApi alloc] init];

// Generate Business Entity / DataBlock documentation
[apiInstance generateDBOrEntityDocWith:elementId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.AutoDocControllerApi()
var elementId = 789; // {{Long}} elementId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateDBOrEntityDoc(elementId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class generateDBOrEntityDocExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AutoDocControllerApi();
            var elementId = 789;  // Long | elementId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Generate Business Entity / DataBlock documentation
                apiInstance.generateDBOrEntityDoc(elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutoDocControllerApi.generateDBOrEntityDoc: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAutoDocControllerApi();
$elementId = 789; // Long | elementId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->generateDBOrEntityDoc($elementId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling AutoDocControllerApi->generateDBOrEntityDoc: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutoDocControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AutoDocControllerApi->new();
my $elementId = 789; # Long | elementId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->generateDBOrEntityDoc(elementId => $elementId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling AutoDocControllerApi->generateDBOrEntityDoc: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AutoDocControllerApi()
elementId = 789 # Long | elementId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Generate Business Entity / DataBlock documentation
    api_instance.generate_db_or_entity_doc(elementId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling AutoDocControllerApi->generateDBOrEntityDoc: %s\n" % e)

Parameters

Path parameters
Name Description
elementId*
Long (int64)
elementId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


BarChartController

checkConfigUsingGET

Check the configuration informations of an existing chart


/service/charts/bar/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/bar/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#checkConfigUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#checkConfigUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGETWith:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.checkConfigUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->checkConfigUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->checkConfigUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->checkConfigUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createBarChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/bar

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/bar?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createBarChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#createBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createBarChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#createBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Create a new chart
[apiInstance createBarChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBarChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createBarChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.createBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createBarChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->createBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createBarChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->createBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_bar_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->createBarChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createBarChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/bar/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/bar/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createBarChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#createBarChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createBarChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#createBarChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createBarChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBarChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBarChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createBarChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.createBarChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createBarChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->createBarChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createBarChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->createBarChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_bar_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->createBarChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteBarChart

Delete an existing chart


/service/charts/bar/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/bar/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBarChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#deleteBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBarChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#deleteBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteBarChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBarChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteBarChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.deleteBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteBarChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->deleteBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBarChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->deleteBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_bar_chart(id, project=project)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->deleteBarChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateBarChart

Duplicate an existing chart


/service/charts/bar/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/bar/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateBarChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#duplicateBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateBarChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#duplicateBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateBarChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateBarChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateBarChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.duplicateBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateBarChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->duplicateBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateBarChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->duplicateBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_bar_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->duplicateBarChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editBarChartConfig

Update the configuration informations of an existing chart


/service/charts/bar/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/bar/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        UpdateBarChartConfigEntry body = ; // UpdateBarChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editBarChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#editBarChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        UpdateBarChartConfigEntry body = ; // UpdateBarChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editBarChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#editBarChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateBarChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editBarChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var body = ; // {{UpdateBarChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editBarChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editBarChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var body = new UpdateBarChartConfigEntry(); // UpdateBarChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editBarChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.editBarChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$body = ; // UpdateBarChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editBarChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->editBarChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateBarChartConfigEntry->new(); # UpdateBarChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editBarChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->editBarChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
body =  # UpdateBarChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_bar_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->editBarChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editBarChartFromDb

Edit chart

Edit an existing chart


/service/charts/bar/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/bar/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editBarChartFromDb(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#editBarChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editBarChartFromDb(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#editBarChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Edit chart
[apiInstance editBarChartFromDbWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editBarChartFromDb(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editBarChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editBarChartFromDb(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.editBarChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editBarChartFromDb($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->editBarChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editBarChartFromDb(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->editBarChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_bar_chart_from_db(body, id, project=project)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->editBarChartFromDb: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getBarChartConfig

Get the configuration informations of an existing chart


/service/charts/bar/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/bar/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            BarChartConfig result = apiInstance.getBarChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#getBarChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            BarChartConfig result = apiInstance.getBarChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#getBarChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getBarChartConfigWith:id
    project:project
              completionHandler: ^(BarChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBarChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBarChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                BarChartConfig result = apiInstance.getBarChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.getBarChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBarChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->getBarChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBarChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->getBarChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_bar_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->getBarChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBarChartFromDb

Get a chart by Id


/service/charts/bar/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/bar/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BarChartControllerApi;

import java.io.File;
import java.util.*;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getBarChartFromDb(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#getBarChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BarChartControllerApi;

public class BarChartControllerApiExample {

    public static void main(String[] args) {
        BarChartControllerApi apiInstance = new BarChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getBarChartFromDb(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BarChartControllerApi#getBarChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

BarChartControllerApi *apiInstance = [[BarChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getBarChartFromDbWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BarChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBarChartFromDb(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBarChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BarChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getBarChartFromDb(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BarChartControllerApi.getBarChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBarChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBarChartFromDb($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BarChartControllerApi->getBarChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BarChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBarChartFromDb(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BarChartControllerApi->getBarChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BarChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_bar_chart_from_db(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BarChartControllerApi->getBarChartFromDb: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


BinaryDepotController

createBinaryDepot

create Binary Depot


/service/depots/binary

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        BinaryDepot body = ; // BinaryDepot | binaryDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            BinaryDepot result = apiInstance.createBinaryDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        BinaryDepot body = ; // BinaryDepot | binaryDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            BinaryDepot result = apiInstance.createBinaryDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
BinaryDepot *body = ; // binaryDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// create Binary Depot
[apiInstance createBinaryDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(BinaryDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{BinaryDepot}} binaryDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBinaryDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBinaryDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new BinaryDepot(); // BinaryDepot | binaryDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Binary Depot
                BinaryDepot result = apiInstance.createBinaryDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.createBinaryDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // BinaryDepot | binaryDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createBinaryDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->createBinaryDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::BinaryDepot->new(); # BinaryDepot | binaryDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createBinaryDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->createBinaryDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # BinaryDepot | binaryDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Binary Depot
    api_response = api_instance.create_binary_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->createBinaryDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createBinaryDepotHeader

create Depot Header


/service/depots/binary/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createBinaryDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createBinaryDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createBinaryDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBinaryDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBinaryDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createBinaryDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.createBinaryDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createBinaryDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->createBinaryDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createBinaryDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->createBinaryDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_binary_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->createBinaryDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createBinaryExtraction

create Extraction


/service/depots/binary/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createBinaryExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createBinaryExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// create Extraction
[apiInstance createBinaryExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createBinaryExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBinaryExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createBinaryExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.createBinaryExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createBinaryExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->createBinaryExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createBinaryExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->createBinaryExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_binary_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->createBinaryExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createBinaryExtractionFilter

create Extraction Filter


/service/depots/binary/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createBinaryExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createBinaryExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#createBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createBinaryExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBinaryExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBinaryExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createBinaryExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.createBinaryExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createBinaryExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->createBinaryExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createBinaryExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->createBinaryExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_binary_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->createBinaryExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllBinaryDepotHeader

delete All Depot Header


/service/depots/binary/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/binary/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllBinaryDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteAllBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllBinaryDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteAllBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllBinaryDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllBinaryDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllBinaryDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllBinaryDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.deleteAllBinaryDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllBinaryDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->deleteAllBinaryDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllBinaryDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->deleteAllBinaryDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_binary_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->deleteAllBinaryDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteBinaryDepot

delete Binary Depot


/service/depots/binary/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/binary/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBinaryDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBinaryDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// delete Binary Depot
[apiInstance deleteBinaryDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBinaryDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBinaryDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Binary Depot
                apiInstance.deleteBinaryDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.deleteBinaryDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteBinaryDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->deleteBinaryDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBinaryDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->deleteBinaryDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # delete Binary Depot
    api_instance.delete_binary_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->deleteBinaryDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteBinaryDepotFileByName

delete binary file by name


/service/depots/binary/{depotId}/remote_files

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/binary/{depotId}/remote_files?ctx=&fileName=&isTemp=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBinaryDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryDepotFileByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBinaryDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryDepotFileByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Boolean *isTemp = true; // isTemp
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// delete binary file by name
[apiInstance deleteBinaryDepotFileByNameWith:ctx
    depotId:depotId
    fileName:fileName
    isTemp:isTemp
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var isTemp = true; // {{Boolean}} isTemp
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBinaryDepotFileByName(ctx, depotId, fileName, isTemp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBinaryDepotFileByNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var isTemp = true;  // Boolean | isTemp
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete binary file by name
                apiInstance.deleteBinaryDepotFileByName(ctx, depotId, fileName, isTemp, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.deleteBinaryDepotFileByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$isTemp = true; // Boolean | isTemp
$project = 789; // Long | Project id

try {
    $api_instance->deleteBinaryDepotFileByName($ctx, $depotId, $fileName, $isTemp, $project);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->deleteBinaryDepotFileByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $isTemp = true; # Boolean | isTemp
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBinaryDepotFileByName(ctx => $ctx, depotId => $depotId, fileName => $fileName, isTemp => $isTemp, project => $project);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->deleteBinaryDepotFileByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
isTemp = true # Boolean | isTemp
project = 789 # Long | Project id (optional)

try: 
    # delete binary file by name
    api_instance.delete_binary_depot_file_by_name(ctx, depotId, fileName, isTemp, project=project)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->deleteBinaryDepotFileByName: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
isTemp*
Boolean
isTemp
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteBinaryDepotHeader

delete Depot Header


/service/depots/binary/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteBinaryDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteBinaryDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteBinaryDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteBinaryDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBinaryDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteBinaryDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.deleteBinaryDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteBinaryDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->deleteBinaryDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteBinaryDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->deleteBinaryDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_binary_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->deleteBinaryDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteBinaryExtraction

delete Extraction


/service/depots/binary/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/binary/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBinaryExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBinaryExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteBinaryExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBinaryExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBinaryExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteBinaryExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.deleteBinaryExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteBinaryExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->deleteBinaryExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBinaryExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->deleteBinaryExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_binary_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->deleteBinaryExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteBinaryExtractionFilter

delete Extraction Filter


/service/depots/binary/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteBinaryExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteBinaryExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#deleteBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteBinaryExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteBinaryExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBinaryExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteBinaryExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.deleteBinaryExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteBinaryExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->deleteBinaryExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteBinaryExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->deleteBinaryExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_binary_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->deleteBinaryExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


downloadLocalBinaryFile

Download local Binary file


/service/depot/binary/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depot/binary/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalBinaryFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#downloadLocalBinaryFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalBinaryFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#downloadLocalBinaryFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Download local Binary file
[apiInstance downloadLocalBinaryFileWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadLocalBinaryFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadLocalBinaryFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download local Binary file
                apiInstance.downloadLocalBinaryFile(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.downloadLocalBinaryFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadLocalBinaryFile($token);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->downloadLocalBinaryFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadLocalBinaryFile(token => $token);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->downloadLocalBinaryFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download local Binary file
    api_instance.download_local_binary_file(token=token)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->downloadLocalBinaryFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editBinaryDepot

edit Binary Depot


/service/depots/binary/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/{depotId}?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        BinaryDepot body = ; // BinaryDepot | binaryDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            BinaryDepot result = apiInstance.editBinaryDepot(body, ctx, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#editBinaryDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        BinaryDepot body = ; // BinaryDepot | binaryDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            BinaryDepot result = apiInstance.editBinaryDepot(body, ctx, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#editBinaryDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
BinaryDepot *body = ; // binaryDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// edit Binary Depot
[apiInstance editBinaryDepotWith:body
    ctx:ctx
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(BinaryDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{BinaryDepot}} binaryDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editBinaryDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editBinaryDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new BinaryDepot(); // BinaryDepot | binaryDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // edit Binary Depot
                BinaryDepot result = apiInstance.editBinaryDepot(body, ctx, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.editBinaryDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // BinaryDepot | binaryDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->editBinaryDepot($body, $ctx, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->editBinaryDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::BinaryDepot->new(); # BinaryDepot | binaryDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->editBinaryDepot(body => $body, ctx => $ctx, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->editBinaryDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # BinaryDepot | binaryDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # edit Binary Depot
    api_response = api_instance.edit_binary_depot(body, ctx, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->editBinaryDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


editBinaryDepotHeader

edit Depot Header


/service/depots/binary/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editBinaryDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#editBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editBinaryDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#editBinaryDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editBinaryDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editBinaryDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editBinaryDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editBinaryDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.editBinaryDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editBinaryDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->editBinaryDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editBinaryDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->editBinaryDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_binary_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->editBinaryDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editBinaryExtractionFilter

edit Extraction Filter


/service/depots/binary/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editBinaryExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#editBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editBinaryExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#editBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editBinaryExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editBinaryExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editBinaryExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editBinaryExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.editBinaryExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editBinaryExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->editBinaryExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editBinaryExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->editBinaryExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_binary_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->editBinaryExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllBinaryDepot

Find All Binary Depot


/service/depots/binary

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[BinaryDepot] result = apiInstance.findAllBinaryDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#findAllBinaryDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[BinaryDepot] result = apiInstance.findAllBinaryDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#findAllBinaryDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Find All Binary Depot
[apiInstance findAllBinaryDepotWith:project
              completionHandler: ^(array[BinaryDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllBinaryDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllBinaryDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Find All Binary Depot
                array[BinaryDepot] result = apiInstance.findAllBinaryDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.findAllBinaryDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllBinaryDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->findAllBinaryDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllBinaryDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->findAllBinaryDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # Find All Binary Depot
    api_response = api_instance.find_all_binary_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->findAllBinaryDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllBinaryExtractionFilters

find All Extraction Filters


/service/depots/binary/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllBinaryExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#findAllBinaryExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllBinaryExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#findAllBinaryExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllBinaryExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllBinaryExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllBinaryExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllBinaryExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.findAllBinaryExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllBinaryExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->findAllBinaryExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllBinaryExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->findAllBinaryExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_binary_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->findAllBinaryExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneBinaryDepotById

find One BinaryDepot By Id


/service/depots/binary/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            BinaryDepot result = apiInstance.findOneBinaryDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#findOneBinaryDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            BinaryDepot result = apiInstance.findOneBinaryDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#findOneBinaryDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// find One BinaryDepot By Id
[apiInstance findOneBinaryDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(BinaryDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneBinaryDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneBinaryDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // find One BinaryDepot By Id
                BinaryDepot result = apiInstance.findOneBinaryDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.findOneBinaryDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneBinaryDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->findOneBinaryDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneBinaryDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->findOneBinaryDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # find One BinaryDepot By Id
    api_response = api_instance.find_one_binary_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->findOneBinaryDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryDepotFilesCount

Get binary depot files count


/service/depots/binary/{depotId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/count?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getBinaryDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryDepotFilesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getBinaryDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryDepotFilesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Get binary depot files count
[apiInstance getBinaryDepotFilesCountWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryDepotFilesCount(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryDepotFilesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get binary depot files count
                Long result = apiInstance.getBinaryDepotFilesCount(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryDepotFilesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBinaryDepotFilesCount($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryDepotFilesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBinaryDepotFilesCount(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryDepotFilesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get binary depot files count
    api_response = api_instance.get_binary_depot_files_count(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryDepotFilesCount: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryDepotHeadersByDepotId

get DepotHeaders By Depot Id


/service/depots/binary/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getBinaryDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getBinaryDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// get DepotHeaders By Depot Id
[apiInstance getBinaryDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get DepotHeaders By Depot Id
                array[DepotHeader] result = apiInstance.getBinaryDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBinaryDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBinaryDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get DepotHeaders By Depot Id
    api_response = api_instance.get_binary_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryDepotRemoteFiles

Get binary depot remoteFiles


/service/depots/binary/{depotId}/remote_files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/remote_files?ctx=&filenameMask=&includeTemp=&limit=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getBinaryDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getBinaryDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *filenameMask = filenameMask_example; // filenameMask
Boolean *includeTemp = true; // includeTemp
Integer *limit = 56; // limit
Long *project = 789; // Project id (optional)
String *remotePath = remotePath_example; // remotePath (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Get binary depot remoteFiles
[apiInstance getBinaryDepotRemoteFilesWith:ctx
    depotId:depotId
    filenameMask:filenameMask
    includeTemp:includeTemp
    limit:limit
    project:project
    remotePath:remotePath
              completionHandler: ^(array[RemoteFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var filenameMask = filenameMask_example; // {{String}} filenameMask
var includeTemp = true; // {{Boolean}} includeTemp
var limit = 56; // {{Integer}} limit
var opts = { 
  'project': 789, // {{Long}} Project id
  'remotePath': remotePath_example // {{String}} remotePath
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryDepotRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var filenameMask = filenameMask_example;  // String | filenameMask
            var includeTemp = true;  // Boolean | includeTemp
            var limit = 56;  // Integer | limit
            var project = 789;  // Long | Project id (optional) 
            var remotePath = remotePath_example;  // String | remotePath (optional) 

            try
            {
                // Get binary depot remoteFiles
                array[RemoteFile] result = apiInstance.getBinaryDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryDepotRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$filenameMask = filenameMask_example; // String | filenameMask
$includeTemp = true; // Boolean | includeTemp
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$remotePath = remotePath_example; // String | remotePath

try {
    $result = $api_instance->getBinaryDepotRemoteFiles($ctx, $depotId, $filenameMask, $includeTemp, $limit, $project, $remotePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryDepotRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $filenameMask = filenameMask_example; # String | filenameMask
my $includeTemp = true; # Boolean | includeTemp
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $remotePath = remotePath_example; # String | remotePath

eval { 
    my $result = $api_instance->getBinaryDepotRemoteFiles(ctx => $ctx, depotId => $depotId, filenameMask => $filenameMask, includeTemp => $includeTemp, limit => $limit, project => $project, remotePath => $remotePath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryDepotRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
filenameMask = filenameMask_example # String | filenameMask
includeTemp = true # Boolean | includeTemp
limit = 56 # Integer | limit
project = 789 # Long | Project id (optional)
remotePath = remotePath_example # String | remotePath (optional)

try: 
    # Get binary depot remoteFiles
    api_response = api_instance.get_binary_depot_remote_files(ctx, depotId, filenameMask, includeTemp, limit, project=project, remotePath=remotePath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryDepotRemoteFiles: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filenameMask*
String
filenameMask
Required
includeTemp*
Boolean
includeTemp
Required
limit*
Integer (int32)
limit
Required
project
Long (int64)
Project id
remotePath
String
remotePath

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryExtractionFilePreview

get Extraction File Preview


/service/depots/binary/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getBinaryExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getBinaryExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getBinaryExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getBinaryExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getBinaryExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getBinaryExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_binary_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryExtractionFilter

list Extraction Filter


/service/depots/binary/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getBinaryExtractionFilter(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getBinaryExtractionFilter(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// list Extraction Filter
[apiInstance getBinaryExtractionFilterWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryExtractionFilter(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // list Extraction Filter
                array['String'] result = apiInstance.getBinaryExtractionFilter(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBinaryExtractionFilter($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBinaryExtractionFilter(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # list Extraction Filter
    api_response = api_instance.get_binary_extraction_filter(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryFileDownloadToken

Get download token for a local Binary file


/service/depot/binary/{depotId}/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/depot/binary/{depotId}/file/token?fileName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getBinaryFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryFileDownloadToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getBinaryFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryFileDownloadToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Get download token for a local Binary file
[apiInstance getBinaryFileDownloadTokenWith:depotId
    fileName:fileName
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryFileDownloadToken(depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryFileDownloadTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get download token for a local Binary file
                'String' result = apiInstance.getBinaryFileDownloadToken(depotId, fileName, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryFileDownloadToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBinaryFileDownloadToken($depotId, $fileName, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryFileDownloadToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBinaryFileDownloadToken(depotId => $depotId, fileName => $fileName, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryFileDownloadToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)

try: 
    # Get download token for a local Binary file
    api_response = api_instance.get_binary_file_download_token(depotId, fileName, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryFileDownloadToken: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
fileName*
String
fileName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getBinaryPreviewDepot

Get binary depot remoteFiles


/service/depots/binary/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            InputStreamResource result = apiInstance.getBinaryPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            InputStreamResource result = apiInstance.getBinaryPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getBinaryPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Get binary depot remoteFiles
[apiInstance getBinaryPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(InputStreamResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBinaryPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBinaryPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get binary depot remoteFiles
                InputStreamResource result = apiInstance.getBinaryPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getBinaryPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getBinaryPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getBinaryPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getBinaryPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getBinaryPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get binary depot remoteFiles
    api_response = api_instance.get_binary_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getBinaryPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersFromBinaryDepot

Get headers from a CSV depot


/service/depots/binary/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/headers?ctx=&inferSchema=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromBinaryDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getHeadersFromBinaryDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromBinaryDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#getHeadersFromBinaryDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CsvDepot *body = ; // csvDepot
Integer *ctx = 56; // ctx
Boolean *inferSchema = true; // inferSchema (optional)
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Get headers from a CSV depot
[apiInstance getHeadersFromBinaryDepotWith:body
    ctx:ctx
    inferSchema:inferSchema
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{CsvDepot}} csvDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'inferSchema': true // {{Boolean}} inferSchema
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersFromBinaryDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersFromBinaryDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new CsvDepot(); // CsvDepot | csvDepot
            var ctx = 56;  // Integer | ctx
            var inferSchema = true;  // Boolean | inferSchema (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a CSV depot
                array[array[Object]] result = apiInstance.getHeadersFromBinaryDepot(body, ctx, inferSchema, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.getHeadersFromBinaryDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // CsvDepot | csvDepot
$ctx = 56; // Integer | ctx
$inferSchema = true; // Boolean | inferSchema
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHeadersFromBinaryDepot($body, $ctx, $inferSchema, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->getHeadersFromBinaryDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::CsvDepot->new(); # CsvDepot | csvDepot
my $ctx = 56; # Integer | ctx
my $inferSchema = true; # Boolean | inferSchema
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHeadersFromBinaryDepot(body => $body, ctx => $ctx, inferSchema => $inferSchema, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->getHeadersFromBinaryDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # CsvDepot | csvDepot
ctx = 56 # Integer | ctx
inferSchema = true # Boolean | inferSchema (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a CSV depot
    api_response = api_instance.get_headers_from_binary_depot(body, ctx, inferSchema=inferSchema, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->getHeadersFromBinaryDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
inferSchema
Boolean
inferSchema
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleBinaryFileUpload

Upload Binary file to a depot


/service/depots/binary/upload_file

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/upload_file?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleBinaryFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#handleBinaryFileUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleBinaryFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#handleBinaryFileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Upload Binary file to a depot
[apiInstance handleBinaryFileUploadWith:ctx
    project:project
              completionHandler: ^(FileUpload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleBinaryFileUpload(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleBinaryFileUploadExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Upload Binary file to a depot
                FileUpload result = apiInstance.handleBinaryFileUpload(ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.handleBinaryFileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleBinaryFileUpload($ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->handleBinaryFileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleBinaryFileUpload(ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->handleBinaryFileUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Upload Binary file to a depot
    api_response = api_instance.handle_binary_file_upload(ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->handleBinaryFileUpload: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveBinaryDepotTempFolderOnTypeUpdate

move temp folder when type is changed


/service/depots/binary/move_tmp_folder_on_type_update

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/binary/move_tmp_folder_on_type_update?ctx=&depotCode=&newDepotType=&oldDepotType=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveBinaryDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#moveBinaryDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveBinaryDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#moveBinaryDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *depotCode = depotCode_example; // depotCode
String *newDepotType = newDepotType_example; // newDepotType
String *oldDepotType = oldDepotType_example; // oldDepotType
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// move temp folder when type is changed
[apiInstance moveBinaryDepotTempFolderOnTypeUpdateWith:ctx
    depotCode:depotCode
    newDepotType:newDepotType
    oldDepotType:oldDepotType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotCode = depotCode_example; // {{String}} depotCode
var newDepotType = newDepotType_example; // {{String}} newDepotType
var oldDepotType = oldDepotType_example; // {{String}} oldDepotType
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveBinaryDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveBinaryDepotTempFolderOnTypeUpdateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotCode = depotCode_example;  // String | depotCode
            var newDepotType = newDepotType_example;  // String | newDepotType
            var oldDepotType = oldDepotType_example;  // String | oldDepotType
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // move temp folder when type is changed
                apiInstance.moveBinaryDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.moveBinaryDepotTempFolderOnTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotCode = depotCode_example; // String | depotCode
$newDepotType = newDepotType_example; // String | newDepotType
$oldDepotType = oldDepotType_example; // String | oldDepotType
$project = 789; // Long | Project id

try {
    $api_instance->moveBinaryDepotTempFolderOnTypeUpdate($ctx, $depotCode, $newDepotType, $oldDepotType, $project);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->moveBinaryDepotTempFolderOnTypeUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotCode = depotCode_example; # String | depotCode
my $newDepotType = newDepotType_example; # String | newDepotType
my $oldDepotType = oldDepotType_example; # String | oldDepotType
my $project = 789; # Long | Project id

eval { 
    $api_instance->moveBinaryDepotTempFolderOnTypeUpdate(ctx => $ctx, depotCode => $depotCode, newDepotType => $newDepotType, oldDepotType => $oldDepotType, project => $project);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->moveBinaryDepotTempFolderOnTypeUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotCode = depotCode_example # String | depotCode
newDepotType = newDepotType_example # String | newDepotType
oldDepotType = oldDepotType_example # String | oldDepotType
project = 789 # Long | Project id (optional)

try: 
    # move temp folder when type is changed
    api_instance.move_binary_depot_temp_folder_on_type_update(ctx, depotCode, newDepotType, oldDepotType, project=project)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->moveBinaryDepotTempFolderOnTypeUpdate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotCode*
String
depotCode
Required
newDepotType*
String
newDepotType
Required
oldDepotType*
String
oldDepotType
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


previewBinaryRemoteBinaryFile

Get binary depot file preview


/service/depots/binary/{depotId}/remote_files/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/binary/{depotId}/remote_files/preview?ctx=&fileName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            InputStreamResource result = apiInstance.previewBinaryRemoteBinaryFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#previewBinaryRemoteBinaryFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            InputStreamResource result = apiInstance.previewBinaryRemoteBinaryFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#previewBinaryRemoteBinaryFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// Get binary depot file preview
[apiInstance previewBinaryRemoteBinaryFileWith:ctx
    depotId:depotId
    fileName:fileName
    project:project
    useCache:useCache
              completionHandler: ^(InputStreamResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewBinaryRemoteBinaryFile(ctx, depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewBinaryRemoteBinaryFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Get binary depot file preview
                InputStreamResource result = apiInstance.previewBinaryRemoteBinaryFile(ctx, depotId, fileName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.previewBinaryRemoteBinaryFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->previewBinaryRemoteBinaryFile($ctx, $depotId, $fileName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->previewBinaryRemoteBinaryFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->previewBinaryRemoteBinaryFile(ctx => $ctx, depotId => $depotId, fileName => $fileName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->previewBinaryRemoteBinaryFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Get binary depot file preview
    api_response = api_instance.preview_binary_remote_binary_file(ctx, depotId, fileName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->previewBinaryRemoteBinaryFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateBinaryDepotActivationStatus

update Depot Activation Status


/service/depots/binary/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/binary/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateBinaryDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#updateBinaryDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateBinaryDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#updateBinaryDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateBinaryDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateBinaryDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateBinaryDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateBinaryDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.updateBinaryDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateBinaryDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->updateBinaryDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateBinaryDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->updateBinaryDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_binary_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->updateBinaryDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateBinaryDepotHeadersPositions

update Depot Headers Positions


/service/depots/binary/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/binary/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BinaryDepotControllerApi;

import java.io.File;
import java.util.*;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateBinaryDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#updateBinaryDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BinaryDepotControllerApi;

public class BinaryDepotControllerApiExample {

    public static void main(String[] args) {
        BinaryDepotControllerApi apiInstance = new BinaryDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateBinaryDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling BinaryDepotControllerApi#updateBinaryDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

BinaryDepotControllerApi *apiInstance = [[BinaryDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateBinaryDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.BinaryDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateBinaryDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateBinaryDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BinaryDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateBinaryDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BinaryDepotControllerApi.updateBinaryDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBinaryDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateBinaryDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling BinaryDepotControllerApi->updateBinaryDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BinaryDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BinaryDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateBinaryDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling BinaryDepotControllerApi->updateBinaryDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BinaryDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_binary_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling BinaryDepotControllerApi->updateBinaryDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


CaracController

createCarac

create new carac


/service/caracs/{entiteTypeId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/caracs/{entiteTypeId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        CaracEntry body = ; // CaracEntry | caracEntry
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createCarac(body, entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#createCarac");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        CaracEntry body = ; // CaracEntry | caracEntry
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createCarac(body, entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#createCarac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CaracEntry *body = ; // caracEntry
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// create new carac
[apiInstance createCaracWith:body
    entiteTypeId:entiteTypeId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var body = ; // {{CaracEntry}} caracEntry
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCarac(bodyentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCaracExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var body = new CaracEntry(); // CaracEntry | caracEntry
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create new carac
                Long result = apiInstance.createCarac(body, entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.createCarac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$body = ; // CaracEntry | caracEntry
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createCarac($body, $entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->createCarac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $body = WWW::SwaggerClient::Object::CaracEntry->new(); # CaracEntry | caracEntry
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createCarac(body => $body, entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->createCarac: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
body =  # CaracEntry | caracEntry
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # create new carac
    api_response = api_instance.create_carac(body, entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->createCarac: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createCaracAndMappingFromDepotByLinkId

create Carac And Mapping From Depot By LinkId


/service/caracs/create/depot/link/{linkId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/create/depot/link/{linkId}?createRepDetails=&prefix=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long linkId = 789; // Long | linkId
        Boolean createRepDetails = true; // Boolean | createRepDetails
        String prefix = prefix_example; // String | prefix
        Long project = 789; // Long | Project id
        try {
            Tuple2«int,long» result = apiInstance.createCaracAndMappingFromDepotByLinkId(linkId, createRepDetails, prefix, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#createCaracAndMappingFromDepotByLinkId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long linkId = 789; // Long | linkId
        Boolean createRepDetails = true; // Boolean | createRepDetails
        String prefix = prefix_example; // String | prefix
        Long project = 789; // Long | Project id
        try {
            Tuple2«int,long» result = apiInstance.createCaracAndMappingFromDepotByLinkId(linkId, createRepDetails, prefix, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#createCaracAndMappingFromDepotByLinkId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *linkId = 789; // linkId
Boolean *createRepDetails = true; // createRepDetails (optional)
String *prefix = prefix_example; // prefix (optional)
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// create Carac And Mapping From Depot By LinkId
[apiInstance createCaracAndMappingFromDepotByLinkIdWith:linkId
    createRepDetails:createRepDetails
    prefix:prefix
    project:project
              completionHandler: ^(Tuple2«int,long» output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var linkId = 789; // {{Long}} linkId
var opts = { 
  'createRepDetails': true, // {{Boolean}} createRepDetails
  'prefix': prefix_example, // {{String}} prefix
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCaracAndMappingFromDepotByLinkId(linkId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCaracAndMappingFromDepotByLinkIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var linkId = 789;  // Long | linkId
            var createRepDetails = true;  // Boolean | createRepDetails (optional) 
            var prefix = prefix_example;  // String | prefix (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Carac And Mapping From Depot By LinkId
                Tuple2«int,long» result = apiInstance.createCaracAndMappingFromDepotByLinkId(linkId, createRepDetails, prefix, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.createCaracAndMappingFromDepotByLinkId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$linkId = 789; // Long | linkId
$createRepDetails = true; // Boolean | createRepDetails
$prefix = prefix_example; // String | prefix
$project = 789; // Long | Project id

try {
    $result = $api_instance->createCaracAndMappingFromDepotByLinkId($linkId, $createRepDetails, $prefix, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->createCaracAndMappingFromDepotByLinkId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $linkId = 789; # Long | linkId
my $createRepDetails = true; # Boolean | createRepDetails
my $prefix = prefix_example; # String | prefix
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createCaracAndMappingFromDepotByLinkId(linkId => $linkId, createRepDetails => $createRepDetails, prefix => $prefix, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->createCaracAndMappingFromDepotByLinkId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
linkId = 789 # Long | linkId
createRepDetails = true # Boolean | createRepDetails (optional)
prefix = prefix_example # String | prefix (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Carac And Mapping From Depot By LinkId
    api_response = api_instance.create_carac_and_mapping_from_depot_by_link_id(linkId, createRepDetails=createRepDetails, prefix=prefix, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->createCaracAndMappingFromDepotByLinkId: %s\n" % e)

Parameters

Path parameters
Name Description
linkId*
Long (int64)
linkId
Required
Query parameters
Name Description
createRepDetails
Boolean
createRepDetails
prefix
String
prefix
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteCarac

delete carac


/service/caracs/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/caracs/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCarac(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#deleteCarac");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCarac(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#deleteCarac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// delete carac
[apiInstance deleteCaracWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCarac(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCaracExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete carac
                apiInstance.deleteCarac(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.deleteCarac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $api_instance->deleteCarac($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->deleteCarac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteCarac(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->deleteCarac: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # delete carac
    api_instance.delete_carac(id, project=project)
except ApiException as e:
    print("Exception when calling CaracControllerApi->deleteCarac: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editCarac

edit carac


/service/caracs/{entiteTypeId}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/caracs/{entiteTypeId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        CaracEntry body = ; // CaracEntry | caracEntry
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            apiInstance.editCarac(body, entiteTypeId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#editCarac");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        CaracEntry body = ; // CaracEntry | caracEntry
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            apiInstance.editCarac(body, entiteTypeId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#editCarac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CaracEntry *body = ; // caracEntry
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// edit carac
[apiInstance editCaracWith:body
    entiteTypeId:entiteTypeId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var body = ; // {{CaracEntry}} caracEntry
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editCarac(bodyentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editCaracExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var body = new CaracEntry(); // CaracEntry | caracEntry
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit carac
                apiInstance.editCarac(body, entiteTypeId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.editCarac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$body = ; // CaracEntry | caracEntry
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $api_instance->editCarac($body, $entiteTypeId, $project);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->editCarac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $body = WWW::SwaggerClient::Object::CaracEntry->new(); # CaracEntry | caracEntry
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    $api_instance->editCarac(body => $body, entiteTypeId => $entiteTypeId, project => $project);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->editCarac: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
body =  # CaracEntry | caracEntry
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # edit carac
    api_instance.edit_carac(body, entiteTypeId, project=project)
except ApiException as e:
    print("Exception when calling CaracControllerApi->editCarac: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findCaracLabel

find carac label


/service/caracs/{id}/libs

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/{id}/libs?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            MetadataLabel result = apiInstance.findCaracLabel(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findCaracLabel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            MetadataLabel result = apiInstance.findCaracLabel(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findCaracLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// find carac label
[apiInstance findCaracLabelWith:id
    project:project
              completionHandler: ^(MetadataLabel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaracLabel(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaracLabelExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find carac label
                MetadataLabel result = apiInstance.findCaracLabel(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.findCaracLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $result = $api_instance->findCaracLabel($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->findCaracLabel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findCaracLabel(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->findCaracLabel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # find carac label
    api_response = api_instance.find_carac_label(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->findCaracLabel: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findCaracsByEdgeId

find Caracs By EdgeId


/service/caracs/search_by_edge

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/search_by_edge?edgeId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long edgeId = 789; // Long | edgeId
        Long project = 789; // Long | Project id
        try {
            array[ElementaryDataStruct] result = apiInstance.findCaracsByEdgeId(edgeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findCaracsByEdgeId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long edgeId = 789; // Long | edgeId
        Long project = 789; // Long | Project id
        try {
            array[ElementaryDataStruct] result = apiInstance.findCaracsByEdgeId(edgeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findCaracsByEdgeId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *edgeId = 789; // edgeId
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// find Caracs By EdgeId
[apiInstance findCaracsByEdgeIdWith:edgeId
    project:project
              completionHandler: ^(array[ElementaryDataStruct] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var edgeId = 789; // {{Long}} edgeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaracsByEdgeId(edgeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaracsByEdgeIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var edgeId = 789;  // Long | edgeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find Caracs By EdgeId
                array[ElementaryDataStruct] result = apiInstance.findCaracsByEdgeId(edgeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.findCaracsByEdgeId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$edgeId = 789; // Long | edgeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findCaracsByEdgeId($edgeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->findCaracsByEdgeId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $edgeId = 789; # Long | edgeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findCaracsByEdgeId(edgeId => $edgeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->findCaracsByEdgeId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
edgeId = 789 # Long | edgeId
project = 789 # Long | Project id (optional)

try: 
    # find Caracs By EdgeId
    api_response = api_instance.find_caracs_by_edge_id(edgeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->findCaracsByEdgeId: %s\n" % e)

Parameters

Query parameters
Name Description
edgeId*
Long (int64)
edgeId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findCaracsTopValues

find Top Values


/service/caracs/{id}/top_values

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/{id}/top_values?ctx=&entiteTypeId=&limit=&project=&searchMode=&text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String searchMode = searchMode_example; // String | searchMode
        String text = text_example; // String | text
        try {
            map['String', BigDecimal] result = apiInstance.findCaracsTopValues(id, ctx, entiteTypeId, limit, project, searchMode, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findCaracsTopValues");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String searchMode = searchMode_example; // String | searchMode
        String text = text_example; // String | text
        try {
            map['String', BigDecimal] result = apiInstance.findCaracsTopValues(id, ctx, entiteTypeId, limit, project, searchMode, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findCaracsTopValues");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Integer *ctx = 56; // ctx (optional)
Long *entiteTypeId = 789; // entiteTypeId (optional)
Integer *limit = 56; // limit (optional)
Long *project = 789; // Project id (optional)
String *searchMode = searchMode_example; // searchMode (optional)
String *text = text_example; // text (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// find Top Values
[apiInstance findCaracsTopValuesWith:id
    ctx:ctx
    entiteTypeId:entiteTypeId
    limit:limit
    project:project
    searchMode:searchMode
    text:text
              completionHandler: ^(map['String', BigDecimal] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var id = 789; // {{Long}} id
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'entiteTypeId': 789, // {{Long}} entiteTypeId
  'limit': 56, // {{Integer}} limit
  'project': 789, // {{Long}} Project id
  'searchMode': searchMode_example, // {{String}} searchMode
  'text': text_example // {{String}} text
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaracsTopValues(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaracsTopValuesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var id = 789;  // Long | id
            var ctx = 56;  // Integer | ctx (optional) 
            var entiteTypeId = 789;  // Long | entiteTypeId (optional) 
            var limit = 56;  // Integer | limit (optional) 
            var project = 789;  // Long | Project id (optional) 
            var searchMode = searchMode_example;  // String | searchMode (optional) 
            var text = text_example;  // String | text (optional) 

            try
            {
                // find Top Values
                map['String', BigDecimal] result = apiInstance.findCaracsTopValues(id, ctx, entiteTypeId, limit, project, searchMode, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.findCaracsTopValues: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$id = 789; // Long | id
$ctx = 56; // Integer | ctx
$entiteTypeId = 789; // Long | entiteTypeId
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$searchMode = searchMode_example; // String | searchMode
$text = text_example; // String | text

try {
    $result = $api_instance->findCaracsTopValues($id, $ctx, $entiteTypeId, $limit, $project, $searchMode, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->findCaracsTopValues: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $id = 789; # Long | id
my $ctx = 56; # Integer | ctx
my $entiteTypeId = 789; # Long | entiteTypeId
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $searchMode = searchMode_example; # String | searchMode
my $text = text_example; # String | text

eval { 
    my $result = $api_instance->findCaracsTopValues(id => $id, ctx => $ctx, entiteTypeId => $entiteTypeId, limit => $limit, project => $project, searchMode => $searchMode, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->findCaracsTopValues: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
id = 789 # Long | id
ctx = 56 # Integer | ctx (optional)
entiteTypeId = 789 # Long | entiteTypeId (optional)
limit = 56 # Integer | limit (optional)
project = 789 # Long | Project id (optional)
searchMode = searchMode_example # String | searchMode (optional)
text = text_example # String | text (optional)

try: 
    # find Top Values
    api_response = api_instance.find_caracs_top_values(id, ctx=ctx, entiteTypeId=entiteTypeId, limit=limit, project=project, searchMode=searchMode, text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->findCaracsTopValues: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
entiteTypeId
Long (int64)
entiteTypeId
limit
Integer (int32)
limit
project
Long (int64)
Project id
searchMode
String
searchMode
text
String
text

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findSimpleCaracsByEntiteId

find Simple Caracs By Entite Id


/service/caracs/search_by_entite

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/search_by_entite?entiteId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long entiteId = 789; // Long | entiteId
        Long project = 789; // Long | Project id
        try {
            array[Carac] result = apiInstance.findSimpleCaracsByEntiteId(entiteId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findSimpleCaracsByEntiteId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long entiteId = 789; // Long | entiteId
        Long project = 789; // Long | Project id
        try {
            array[Carac] result = apiInstance.findSimpleCaracsByEntiteId(entiteId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#findSimpleCaracsByEntiteId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteId = 789; // entiteId
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// find Simple Caracs By Entite Id
[apiInstance findSimpleCaracsByEntiteIdWith:entiteId
    project:project
              completionHandler: ^(array[Carac] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var entiteId = 789; // {{Long}} entiteId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findSimpleCaracsByEntiteId(entiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findSimpleCaracsByEntiteIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var entiteId = 789;  // Long | entiteId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find Simple Caracs By Entite Id
                array[Carac] result = apiInstance.findSimpleCaracsByEntiteId(entiteId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.findSimpleCaracsByEntiteId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$entiteId = 789; // Long | entiteId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findSimpleCaracsByEntiteId($entiteId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->findSimpleCaracsByEntiteId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $entiteId = 789; # Long | entiteId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findSimpleCaracsByEntiteId(entiteId => $entiteId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->findSimpleCaracsByEntiteId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
entiteId = 789 # Long | entiteId
project = 789 # Long | Project id (optional)

try: 
    # find Simple Caracs By Entite Id
    api_response = api_instance.find_simple_caracs_by_entite_id(entiteId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->findSimpleCaracsByEntiteId: %s\n" % e)

Parameters

Query parameters
Name Description
entiteId*
Long (int64)
entiteId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCaracById

get carac by id


/service/caracs/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            Carac result = apiInstance.getCaracById(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#getCaracById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            Carac result = apiInstance.getCaracById(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#getCaracById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// get carac by id
[apiInstance getCaracByIdWith:id
    project:project
              completionHandler: ^(Carac output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaracById(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaracByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get carac by id
                Carac result = apiInstance.getCaracById(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.getCaracById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getCaracById($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->getCaracById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCaracById(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->getCaracById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # get carac by id
    api_response = api_instance.get_carac_by_id(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->getCaracById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCaracElementaryDataByUetId

get Carac ElementaryData By UetId


/service/caracs/elementary_data/{entiteTypeId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/elementary_data/{entiteTypeId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            array[ElementaryDataStruct] result = apiInstance.getCaracElementaryDataByUetId(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#getCaracElementaryDataByUetId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            array[ElementaryDataStruct] result = apiInstance.getCaracElementaryDataByUetId(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#getCaracElementaryDataByUetId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// get Carac ElementaryData By UetId
[apiInstance getCaracElementaryDataByUetIdWith:entiteTypeId
    project:project
              completionHandler: ^(array[ElementaryDataStruct] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaracElementaryDataByUetId(entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaracElementaryDataByUetIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Carac ElementaryData By UetId
                array[ElementaryDataStruct] result = apiInstance.getCaracElementaryDataByUetId(entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.getCaracElementaryDataByUetId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getCaracElementaryDataByUetId($entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->getCaracElementaryDataByUetId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCaracElementaryDataByUetId(entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->getCaracElementaryDataByUetId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # get Carac ElementaryData By UetId
    api_response = api_instance.get_carac_elementary_data_by_uet_id(entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->getCaracElementaryDataByUetId: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


searchLinksByMappedCarac

search Links By Mapped Carac


/service/links/search/by_mapped_carac

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/links/search/by_mapped_carac?caracId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.searchLinksByMappedCarac(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#searchLinksByMappedCarac");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.searchLinksByMappedCarac(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#searchLinksByMappedCarac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *caracId = 789; // caracId
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// search Links By Mapped Carac
[apiInstance searchLinksByMappedCaracWith:caracId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var caracId = 789; // {{Long}} caracId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchLinksByMappedCarac(caracId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchLinksByMappedCaracExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var caracId = 789;  // Long | caracId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // search Links By Mapped Carac
                array['String'] result = apiInstance.searchLinksByMappedCarac(caracId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.searchLinksByMappedCarac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$caracId = 789; // Long | caracId
$project = 789; // Long | Project id

try {
    $result = $api_instance->searchLinksByMappedCarac($caracId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->searchLinksByMappedCarac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $caracId = 789; # Long | caracId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->searchLinksByMappedCarac(caracId => $caracId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->searchLinksByMappedCarac: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
caracId = 789 # Long | caracId
project = 789 # Long | Project id (optional)

try: 
    # search Links By Mapped Carac
    api_response = api_instance.search_links_by_mapped_carac(caracId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->searchLinksByMappedCarac: %s\n" % e)

Parameters

Query parameters
Name Description
caracId*
Long (int64)
caracId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


setCaracCf

set CaracCf


/service/caracs/{id}/setCf/{isCf}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/caracs/{id}/setCf/{isCf}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Boolean isCf = true; // Boolean | isCf
        Long project = 789; // Long | Project id
        try {
            apiInstance.setCaracCf(id, isCf, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#setCaracCf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Long id = 789; // Long | id
        Boolean isCf = true; // Boolean | isCf
        Long project = 789; // Long | Project id
        try {
            apiInstance.setCaracCf(id, isCf, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#setCaracCf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Boolean *isCf = true; // isCf
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// set CaracCf
[apiInstance setCaracCfWith:id
    isCf:isCf
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var id = 789; // {{Long}} id
var isCf = true; // {{Boolean}} isCf
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setCaracCf(id, isCf, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setCaracCfExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var id = 789;  // Long | id
            var isCf = true;  // Boolean | isCf
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // set CaracCf
                apiInstance.setCaracCf(id, isCf, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.setCaracCf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$id = 789; // Long | id
$isCf = true; // Boolean | isCf
$project = 789; // Long | Project id

try {
    $api_instance->setCaracCf($id, $isCf, $project);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->setCaracCf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $id = 789; # Long | id
my $isCf = true; # Boolean | isCf
my $project = 789; # Long | Project id

eval { 
    $api_instance->setCaracCf(id => $id, isCf => $isCf, project => $project);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->setCaracCf: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
id = 789 # Long | id
isCf = true # Boolean | isCf
project = 789 # Long | Project id (optional)

try: 
    # set CaracCf
    api_instance.set_carac_cf(id, isCf, project=project)
except ApiException as e:
    print("Exception when calling CaracControllerApi->setCaracCf: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
isCf*
Boolean
isCf
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateCaracFormula

update Carac Formula


/service/caracs/formula

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/caracs/formula?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracControllerApi;

import java.io.File;
import java.util.*;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracControllerApi apiInstance = new CaracControllerApi();
        Carac body = ; // Carac | carac
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.updateCaracFormula(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#updateCaracFormula");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracControllerApi;

public class CaracControllerApiExample {

    public static void main(String[] args) {
        CaracControllerApi apiInstance = new CaracControllerApi();
        Carac body = ; // Carac | carac
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.updateCaracFormula(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracControllerApi#updateCaracFormula");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Carac *body = ; // carac
Long *project = 789; // Project id (optional)

CaracControllerApi *apiInstance = [[CaracControllerApi alloc] init];

// update Carac Formula
[apiInstance updateCaracFormulaWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracControllerApi()
var body = ; // {{Carac}} carac
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCaracFormula(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCaracFormulaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracControllerApi();
            var body = new Carac(); // Carac | carac
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Carac Formula
                Long result = apiInstance.updateCaracFormula(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracControllerApi.updateCaracFormula: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracControllerApi();
$body = ; // Carac | carac
$project = 789; // Long | Project id

try {
    $result = $api_instance->updateCaracFormula($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaracControllerApi->updateCaracFormula: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracControllerApi->new();
my $body = WWW::SwaggerClient::Object::Carac->new(); # Carac | carac
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->updateCaracFormula(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaracControllerApi->updateCaracFormula: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracControllerApi()
body =  # Carac | carac
project = 789 # Long | Project id (optional)

try: 
    # update Carac Formula
    api_response = api_instance.update_carac_formula(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaracControllerApi->updateCaracFormula: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


CaracDepotMappingController

addDepotCaracMapping

add Depot Carac Mapping


/service/entite_file/mapping/add/{caracId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_file/mapping/add/{caracId}?project=&reloadData="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaracDepotMappingControllerApi;

import java.io.File;
import java.util.*;

public class CaracDepotMappingControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CaracDepotMappingControllerApi apiInstance = new CaracDepotMappingControllerApi();
        array[CaracMapping] body = ; // array[CaracMapping] | requestParams
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        Boolean reloadData = true; // Boolean | reloadData
        try {
            apiInstance.addDepotCaracMapping(body, caracId, project, reloadData);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracDepotMappingControllerApi#addDepotCaracMapping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaracDepotMappingControllerApi;

public class CaracDepotMappingControllerApiExample {

    public static void main(String[] args) {
        CaracDepotMappingControllerApi apiInstance = new CaracDepotMappingControllerApi();
        array[CaracMapping] body = ; // array[CaracMapping] | requestParams
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        Boolean reloadData = true; // Boolean | reloadData
        try {
            apiInstance.addDepotCaracMapping(body, caracId, project, reloadData);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaracDepotMappingControllerApi#addDepotCaracMapping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[CaracMapping] *body = ; // requestParams
Long *caracId = 789; // caracId
Long *project = 789; // Project id (optional)
Boolean *reloadData = true; // reloadData (optional)

CaracDepotMappingControllerApi *apiInstance = [[CaracDepotMappingControllerApi alloc] init];

// add Depot Carac Mapping
[apiInstance addDepotCaracMappingWith:body
    caracId:caracId
    project:project
    reloadData:reloadData
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CaracDepotMappingControllerApi()
var body = ; // {{array[CaracMapping]}} requestParams
var caracId = 789; // {{Long}} caracId
var opts = { 
  'project': 789 // {{Long}} Project id
  'reloadData': true // {{Boolean}} reloadData
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addDepotCaracMapping(bodycaracId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addDepotCaracMappingExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CaracDepotMappingControllerApi();
            var body = new array[CaracMapping](); // array[CaracMapping] | requestParams
            var caracId = 789;  // Long | caracId
            var project = 789;  // Long | Project id (optional) 
            var reloadData = true;  // Boolean | reloadData (optional) 

            try
            {
                // add Depot Carac Mapping
                apiInstance.addDepotCaracMapping(body, caracId, project, reloadData);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaracDepotMappingControllerApi.addDepotCaracMapping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCaracDepotMappingControllerApi();
$body = ; // array[CaracMapping] | requestParams
$caracId = 789; // Long | caracId
$project = 789; // Long | Project id
$reloadData = true; // Boolean | reloadData

try {
    $api_instance->addDepotCaracMapping($body, $caracId, $project, $reloadData);
} catch (Exception $e) {
    echo 'Exception when calling CaracDepotMappingControllerApi->addDepotCaracMapping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaracDepotMappingControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CaracDepotMappingControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[CaracMapping]->new()]; # array[CaracMapping] | requestParams
my $caracId = 789; # Long | caracId
my $project = 789; # Long | Project id
my $reloadData = true; # Boolean | reloadData

eval { 
    $api_instance->addDepotCaracMapping(body => $body, caracId => $caracId, project => $project, reloadData => $reloadData);
};
if ($@) {
    warn "Exception when calling CaracDepotMappingControllerApi->addDepotCaracMapping: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CaracDepotMappingControllerApi()
body =  # array[CaracMapping] | requestParams
caracId = 789 # Long | caracId
project = 789 # Long | Project id (optional)
reloadData = true # Boolean | reloadData (optional)

try: 
    # add Depot Carac Mapping
    api_instance.add_depot_carac_mapping(body, caracId, project=project, reloadData=reloadData)
except ApiException as e:
    print("Exception when calling CaracDepotMappingControllerApi->addDepotCaracMapping: %s\n" % e)

Parameters

Path parameters
Name Description
caracId*
Long (int64)
caracId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id
reloadData
Boolean
reloadData

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


CharsetController

findAllUsingGET

findAll


/service/charsets

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charsets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CharsetControllerApi;

import java.io.File;
import java.util.*;

public class CharsetControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CharsetControllerApi apiInstance = new CharsetControllerApi();
        String ifNoneMatch = ifNoneMatch_example; // String | If-None-Match
        try {
            array[Charset] result = apiInstance.findAllUsingGET(ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CharsetControllerApi#findAllUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CharsetControllerApi;

public class CharsetControllerApiExample {

    public static void main(String[] args) {
        CharsetControllerApi apiInstance = new CharsetControllerApi();
        String ifNoneMatch = ifNoneMatch_example; // String | If-None-Match
        try {
            array[Charset] result = apiInstance.findAllUsingGET(ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CharsetControllerApi#findAllUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *ifNoneMatch = ifNoneMatch_example; // If-None-Match (optional)

CharsetControllerApi *apiInstance = [[CharsetControllerApi alloc] init];

// findAll
[apiInstance findAllUsingGETWith:ifNoneMatch
              completionHandler: ^(array[Charset] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CharsetControllerApi()
var opts = { 
  'ifNoneMatch': ifNoneMatch_example // {{String}} If-None-Match
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllUsingGET(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CharsetControllerApi();
            var ifNoneMatch = ifNoneMatch_example;  // String | If-None-Match (optional) 

            try
            {
                // findAll
                array[Charset] result = apiInstance.findAllUsingGET(ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CharsetControllerApi.findAllUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCharsetControllerApi();
$ifNoneMatch = ifNoneMatch_example; // String | If-None-Match

try {
    $result = $api_instance->findAllUsingGET($ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharsetControllerApi->findAllUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CharsetControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CharsetControllerApi->new();
my $ifNoneMatch = ifNoneMatch_example; # String | If-None-Match

eval { 
    my $result = $api_instance->findAllUsingGET(ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CharsetControllerApi->findAllUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CharsetControllerApi()
ifNoneMatch = ifNoneMatch_example # String | If-None-Match (optional)

try: 
    # findAll
    api_response = api_instance.find_all_using_get(ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CharsetControllerApi->findAllUsingGET: %s\n" % e)

Parameters

Header parameters
Name Description
If-None-Match
String
If-None-Match

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


CommentController

deleteComment

delete Comment


/service/COMMENTS/{commentId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/COMMENTS/{commentId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentControllerApi;

import java.io.File;
import java.util.*;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CommentControllerApi apiInstance = new CommentControllerApi();
        Long commentId = 789; // Long | commentId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteComment(commentId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#deleteComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentControllerApi;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        CommentControllerApi apiInstance = new CommentControllerApi();
        Long commentId = 789; // Long | commentId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteComment(commentId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#deleteComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *commentId = 789; // commentId
Long *project = 789; // Project id (optional)

CommentControllerApi *apiInstance = [[CommentControllerApi alloc] init];

// delete Comment
[apiInstance deleteCommentWith:commentId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CommentControllerApi()
var commentId = 789; // {{Long}} commentId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteComment(commentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCommentExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CommentControllerApi();
            var commentId = 789;  // Long | commentId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Comment
                apiInstance.deleteComment(commentId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentControllerApi.deleteComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCommentControllerApi();
$commentId = 789; // Long | commentId
$project = 789; // Long | Project id

try {
    $api_instance->deleteComment($commentId, $project);
} catch (Exception $e) {
    echo 'Exception when calling CommentControllerApi->deleteComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CommentControllerApi->new();
my $commentId = 789; # Long | commentId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteComment(commentId => $commentId, project => $project);
};
if ($@) {
    warn "Exception when calling CommentControllerApi->deleteComment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CommentControllerApi()
commentId = 789 # Long | commentId
project = 789 # Long | Project id (optional)

try: 
    # delete Comment
    api_instance.delete_comment(commentId, project=project)
except ApiException as e:
    print("Exception when calling CommentControllerApi->deleteComment: %s\n" % e)

Parameters

Path parameters
Name Description
commentId*
Long (int64)
commentId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteComments

delete comments


/service/COMMENTS

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/COMMENTS?ids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentControllerApi;

import java.io.File;
import java.util.*;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CommentControllerApi apiInstance = new CommentControllerApi();
        array[Long] ids = ; // array[Long] | ids
        try {
            apiInstance.deleteComments(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#deleteComments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentControllerApi;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        CommentControllerApi apiInstance = new CommentControllerApi();
        array[Long] ids = ; // array[Long] | ids
        try {
            apiInstance.deleteComments(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#deleteComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *ids = ; // ids

CommentControllerApi *apiInstance = [[CommentControllerApi alloc] init];

// delete comments
[apiInstance deleteCommentsWith:ids
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CommentControllerApi()
var ids = ; // {{array[Long]}} ids

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteComments(ids, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCommentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CommentControllerApi();
            var ids = new array[Long](); // array[Long] | ids

            try
            {
                // delete comments
                apiInstance.deleteComments(ids);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentControllerApi.deleteComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCommentControllerApi();
$ids = ; // array[Long] | ids

try {
    $api_instance->deleteComments($ids);
} catch (Exception $e) {
    echo 'Exception when calling CommentControllerApi->deleteComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CommentControllerApi->new();
my $ids = []; # array[Long] | ids

eval { 
    $api_instance->deleteComments(ids => $ids);
};
if ($@) {
    warn "Exception when calling CommentControllerApi->deleteComments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CommentControllerApi()
ids =  # array[Long] | ids

try: 
    # delete comments
    api_instance.delete_comments(ids)
except ApiException as e:
    print("Exception when calling CommentControllerApi->deleteComments: %s\n" % e)

Parameters

Query parameters
Name Description
ids*
array[Long] (int64)
ids
Required

Responses

Status: 200 - OK


listCommentsByElement

list comments By Element


/service/COMMENTS

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/COMMENTS?dcType=&elementId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentControllerApi;

import java.io.File;
import java.util.*;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CommentControllerApi apiInstance = new CommentControllerApi();
        String dcType = dcType_example; // String | dcType
        Long elementId = 789; // Long | elementId
        Long project = 789; // Long | Project id
        try {
            array[Comment] result = apiInstance.listCommentsByElement(dcType, elementId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#listCommentsByElement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentControllerApi;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        CommentControllerApi apiInstance = new CommentControllerApi();
        String dcType = dcType_example; // String | dcType
        Long elementId = 789; // Long | elementId
        Long project = 789; // Long | Project id
        try {
            array[Comment] result = apiInstance.listCommentsByElement(dcType, elementId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#listCommentsByElement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *dcType = dcType_example; // dcType
Long *elementId = 789; // elementId
Long *project = 789; // Project id (optional)

CommentControllerApi *apiInstance = [[CommentControllerApi alloc] init];

// list comments By Element
[apiInstance listCommentsByElementWith:dcType
    elementId:elementId
    project:project
              completionHandler: ^(array[Comment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CommentControllerApi()
var dcType = dcType_example; // {{String}} dcType
var elementId = 789; // {{Long}} elementId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCommentsByElement(dcType, elementId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCommentsByElementExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CommentControllerApi();
            var dcType = dcType_example;  // String | dcType
            var elementId = 789;  // Long | elementId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // list comments By Element
                array[Comment] result = apiInstance.listCommentsByElement(dcType, elementId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentControllerApi.listCommentsByElement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCommentControllerApi();
$dcType = dcType_example; // String | dcType
$elementId = 789; // Long | elementId
$project = 789; // Long | Project id

try {
    $result = $api_instance->listCommentsByElement($dcType, $elementId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentControllerApi->listCommentsByElement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CommentControllerApi->new();
my $dcType = dcType_example; # String | dcType
my $elementId = 789; # Long | elementId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listCommentsByElement(dcType => $dcType, elementId => $elementId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentControllerApi->listCommentsByElement: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CommentControllerApi()
dcType = dcType_example # String | dcType
elementId = 789 # Long | elementId
project = 789 # Long | Project id (optional)

try: 
    # list comments By Element
    api_response = api_instance.list_comments_by_element(dcType, elementId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentControllerApi->listCommentsByElement: %s\n" % e)

Parameters

Query parameters
Name Description
dcType*
String
dcType
Required
elementId*
Long (int64)
elementId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


postComment

postComment


/service/COMMENTS

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/COMMENTS?ISO3Country=&ISO3Language=&country=&dcType=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&elementId=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentControllerApi;

import java.io.File;
import java.util.*;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CommentControllerApi apiInstance = new CommentControllerApi();
        CommentEntry body = ; // CommentEntry | comment
        String dcType = dcType_example; // String | dcType
        Long elementId = 789; // Long | elementId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Comment result = apiInstance.postComment(body, dcType, elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#postComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentControllerApi;

public class CommentControllerApiExample {

    public static void main(String[] args) {
        CommentControllerApi apiInstance = new CommentControllerApi();
        CommentEntry body = ; // CommentEntry | comment
        String dcType = dcType_example; // String | dcType
        Long elementId = 789; // Long | elementId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Comment result = apiInstance.postComment(body, dcType, elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentControllerApi#postComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CommentEntry *body = ; // comment
String *dcType = dcType_example; // dcType
Long *elementId = 789; // elementId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

CommentControllerApi *apiInstance = [[CommentControllerApi alloc] init];

// postComment
[apiInstance postCommentWith:body
    dcType:dcType
    elementId:elementId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Comment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CommentControllerApi()
var body = ; // {{CommentEntry}} comment
var dcType = dcType_example; // {{String}} dcType
var elementId = 789; // {{Long}} elementId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postComment(bodydcTypeelementId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postCommentExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CommentControllerApi();
            var body = new CommentEntry(); // CommentEntry | comment
            var dcType = dcType_example;  // String | dcType
            var elementId = 789;  // Long | elementId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // postComment
                Comment result = apiInstance.postComment(body, dcType, elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentControllerApi.postComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCommentControllerApi();
$body = ; // CommentEntry | comment
$dcType = dcType_example; // String | dcType
$elementId = 789; // Long | elementId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->postComment($body, $dcType, $elementId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentControllerApi->postComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CommentControllerApi->new();
my $body = WWW::SwaggerClient::Object::CommentEntry->new(); # CommentEntry | comment
my $dcType = dcType_example; # String | dcType
my $elementId = 789; # Long | elementId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->postComment(body => $body, dcType => $dcType, elementId => $elementId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentControllerApi->postComment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CommentControllerApi()
body =  # CommentEntry | comment
dcType = dcType_example # String | dcType
elementId = 789 # Long | elementId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # postComment
    api_response = api_instance.post_comment(body, dcType, elementId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentControllerApi->postComment: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
dcType*
String
dcType
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
elementId*
Long (int64)
elementId
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ConnectorController

deleteManyConnectors

Delete a connectors by IDs


/service/connectors

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/connectors?connectorIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        array[Long] connectorIds = ; // array[Long] | connectorIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyConnectors(connectorIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#deleteManyConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorControllerApi;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        array[Long] connectorIds = ; // array[Long] | connectorIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyConnectors(connectorIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#deleteManyConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *connectorIds = ; // connectorIds
Long *project = 789; // Project id (optional)

ConnectorControllerApi *apiInstance = [[ConnectorControllerApi alloc] init];

// Delete a connectors by IDs
[apiInstance deleteManyConnectorsWith:connectorIds
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ConnectorControllerApi()
var connectorIds = ; // {{array[Long]}} connectorIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteManyConnectors(connectorIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteManyConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ConnectorControllerApi();
            var connectorIds = new array[Long](); // array[Long] | connectorIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a connectors by IDs
                apiInstance.deleteManyConnectors(connectorIds, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorControllerApi.deleteManyConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiConnectorControllerApi();
$connectorIds = ; // array[Long] | connectorIds
$project = 789; // Long | Project id

try {
    $api_instance->deleteManyConnectors($connectorIds, $project);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorControllerApi->deleteManyConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ConnectorControllerApi->new();
my $connectorIds = []; # array[Long] | connectorIds
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteManyConnectors(connectorIds => $connectorIds, project => $project);
};
if ($@) {
    warn "Exception when calling ConnectorControllerApi->deleteManyConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ConnectorControllerApi()
connectorIds =  # array[Long] | connectorIds
project = 789 # Long | Project id (optional)

try: 
    # Delete a connectors by IDs
    api_instance.delete_many_connectors(connectorIds, project=project)
except ApiException as e:
    print("Exception when calling ConnectorControllerApi->deleteManyConnectors: %s\n" % e)

Parameters

Query parameters
Name Description
connectorIds*
array[Long] (int64)
connectorIds
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllConnectors

View a list of connectors


/service/connectors

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors?details=&excludeInactive=&excludePublic=&excludedTypes=&includedTypes=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Boolean details = true; // Boolean | Return the metadata object if True, the label and the code only if false
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        array[String] excludedTypes = ; // array[String] | Exclude connectors which the type is present in this list
        array[String] includedTypes = ; // array[String] | Include connectors which the type is present in this list
        Long project = 789; // Long | Project id
        try {
            array[Connector] result = apiInstance.findAllConnectors(details, excludeInactive, excludePublic, excludedTypes, includedTypes, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#findAllConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorControllerApi;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Boolean details = true; // Boolean | Return the metadata object if True, the label and the code only if false
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        array[String] excludedTypes = ; // array[String] | Exclude connectors which the type is present in this list
        array[String] includedTypes = ; // array[String] | Include connectors which the type is present in this list
        Long project = 789; // Long | Project id
        try {
            array[Connector] result = apiInstance.findAllConnectors(details, excludeInactive, excludePublic, excludedTypes, includedTypes, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#findAllConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *details = true; // Return the metadata object if True, the label and the code only if false (optional)
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
array[String] *excludedTypes = ; // Exclude connectors which the type is present in this list (optional)
array[String] *includedTypes = ; // Include connectors which the type is present in this list (optional)
Long *project = 789; // Project id (optional)

ConnectorControllerApi *apiInstance = [[ConnectorControllerApi alloc] init];

// View a list of connectors
[apiInstance findAllConnectorsWith:details
    excludeInactive:excludeInactive
    excludePublic:excludePublic
    excludedTypes:excludedTypes
    includedTypes:includedTypes
    project:project
              completionHandler: ^(array[Connector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ConnectorControllerApi()
var opts = { 
  'details': true, // {{Boolean}} Return the metadata object if True, the label and the code only if false
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'excludedTypes': , // {{array[String]}} Exclude connectors which the type is present in this list
  'includedTypes': , // {{array[String]}} Include connectors which the type is present in this list
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllConnectors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ConnectorControllerApi();
            var details = true;  // Boolean | Return the metadata object if True, the label and the code only if false (optional) 
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var excludedTypes = new array[String](); // array[String] | Exclude connectors which the type is present in this list (optional) 
            var includedTypes = new array[String](); // array[String] | Include connectors which the type is present in this list (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of connectors
                array[Connector] result = apiInstance.findAllConnectors(details, excludeInactive, excludePublic, excludedTypes, includedTypes, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorControllerApi.findAllConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiConnectorControllerApi();
$details = true; // Boolean | Return the metadata object if True, the label and the code only if false
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$excludedTypes = ; // array[String] | Exclude connectors which the type is present in this list
$includedTypes = ; // array[String] | Include connectors which the type is present in this list
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllConnectors($details, $excludeInactive, $excludePublic, $excludedTypes, $includedTypes, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorControllerApi->findAllConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ConnectorControllerApi->new();
my $details = true; # Boolean | Return the metadata object if True, the label and the code only if false
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $excludedTypes = []; # array[String] | Exclude connectors which the type is present in this list
my $includedTypes = []; # array[String] | Include connectors which the type is present in this list
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllConnectors(details => $details, excludeInactive => $excludeInactive, excludePublic => $excludePublic, excludedTypes => $excludedTypes, includedTypes => $includedTypes, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorControllerApi->findAllConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ConnectorControllerApi()
details = true # Boolean | Return the metadata object if True, the label and the code only if false (optional)
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
excludedTypes =  # array[String] | Exclude connectors which the type is present in this list (optional)
includedTypes =  # array[String] | Include connectors which the type is present in this list (optional)
project = 789 # Long | Project id (optional)

try: 
    # View a list of connectors
    api_response = api_instance.find_all_connectors(details=details, excludeInactive=excludeInactive, excludePublic=excludePublic, excludedTypes=excludedTypes, includedTypes=includedTypes, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorControllerApi->findAllConnectors: %s\n" % e)

Parameters

Query parameters
Name Description
details
Boolean
Return the metadata object if True, the label and the code only if false
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
excludedTypes
array[String]
Exclude connectors which the type is present in this list
includedTypes
array[String]
Include connectors which the type is present in this list
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findConnectorById

Get a connector by ID


/service/connectors/{connectorId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Long connectorId = 789; // Long | Connector ID
        Long project = 789; // Long | Project id
        try {
            Connector result = apiInstance.findConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#findConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorControllerApi;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Long connectorId = 789; // Long | Connector ID
        Long project = 789; // Long | Project id
        try {
            Connector result = apiInstance.findConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#findConnectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // Connector ID
Long *project = 789; // Project id (optional)

ConnectorControllerApi *apiInstance = [[ConnectorControllerApi alloc] init];

// Get a connector by ID
[apiInstance findConnectorByIdWith:connectorId
    project:project
              completionHandler: ^(Connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ConnectorControllerApi()
var connectorId = 789; // {{Long}} Connector ID
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findConnectorById(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findConnectorByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ConnectorControllerApi();
            var connectorId = 789;  // Long | Connector ID
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a connector by ID
                Connector result = apiInstance.findConnectorById(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorControllerApi.findConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiConnectorControllerApi();
$connectorId = 789; // Long | Connector ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->findConnectorById($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorControllerApi->findConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ConnectorControllerApi->new();
my $connectorId = 789; # Long | Connector ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findConnectorById(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorControllerApi->findConnectorById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ConnectorControllerApi()
connectorId = 789 # Long | Connector ID
project = 789 # Long | Project id (optional)

try: 
    # Get a connector by ID
    api_response = api_instance.find_connector_by_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorControllerApi->findConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
Connector ID
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getConnectorElementsForMove

Get connector linked element for move/copy


/service/connectors/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Connector ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getConnectorElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#getConnectorElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorControllerApi;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Connector ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getConnectorElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#getConnectorElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Connector ID (optional)
Long *project = 789; // Project id (optional)

ConnectorControllerApi *apiInstance = [[ConnectorControllerApi alloc] init];

// Get connector linked element for move/copy
[apiInstance getConnectorElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ConnectorControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Connector ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ConnectorControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Connector ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get connector linked element for move/copy
                array[DcUsedElement] result = apiInstance.getConnectorElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorControllerApi.getConnectorElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiConnectorControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Connector ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getConnectorElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorControllerApi->getConnectorElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ConnectorControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Connector ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getConnectorElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorControllerApi->getConnectorElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ConnectorControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Connector ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get connector linked element for move/copy
    api_response = api_instance.get_connector_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorControllerApi->getConnectorElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Connector ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveElements

Move connector and linked elements to another project


/service/connectors/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Connector ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#moveElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorControllerApi;

public class ConnectorControllerApiExample {

    public static void main(String[] args) {
        ConnectorControllerApi apiInstance = new ConnectorControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Connector ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorControllerApi#moveElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Connector ID (optional)
Long *project = 789; // Project id (optional)

ConnectorControllerApi *apiInstance = [[ConnectorControllerApi alloc] init];

// Move connector and linked elements to another project
[apiInstance moveElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ConnectorControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Connector ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ConnectorControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Connector ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move connector and linked elements to another project
                DcMoveResponse result = apiInstance.moveElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorControllerApi.moveElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiConnectorControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Connector ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorControllerApi->moveElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ConnectorControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Connector ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorControllerApi->moveElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ConnectorControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Connector ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move connector and linked elements to another project
    api_response = api_instance.move_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorControllerApi->moveElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Connector ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


CsvDepotController

createCsvDepot

create Csv Depot


/service/depots/csv

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            CsvDepot result = apiInstance.createCsvDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            CsvDepot result = apiInstance.createCsvDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CsvDepot *body = ; // csvDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// create Csv Depot
[apiInstance createCsvDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(CsvDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{CsvDepot}} csvDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCsvDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCsvDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new CsvDepot(); // CsvDepot | csvDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Csv Depot
                CsvDepot result = apiInstance.createCsvDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.createCsvDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // CsvDepot | csvDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createCsvDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->createCsvDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::CsvDepot->new(); # CsvDepot | csvDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createCsvDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->createCsvDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # CsvDepot | csvDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Csv Depot
    api_response = api_instance.create_csv_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->createCsvDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createCsvDepotHeader

create DepotHeader


/service/depots/csv/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createCsvDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createCsvDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// create DepotHeader
[apiInstance createCsvDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCsvDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCsvDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create DepotHeader
                array[DepotHeader] result = apiInstance.createCsvDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.createCsvDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createCsvDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->createCsvDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createCsvDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->createCsvDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create DepotHeader
    api_response = api_instance.create_csv_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->createCsvDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createCsvExtraction

create Extraction


/service/depots/csv/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createCsvExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createCsvExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// create Extraction
[apiInstance createCsvExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCsvExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCsvExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createCsvExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.createCsvExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createCsvExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->createCsvExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createCsvExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->createCsvExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_csv_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->createCsvExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createCsvExtractionFilter

create Extraction Filter


/service/depots/csv/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createCsvExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createCsvExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#createCsvExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createCsvExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCsvExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCsvExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createCsvExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.createCsvExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createCsvExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->createCsvExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createCsvExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->createCsvExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_csv_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->createCsvExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllCsvDepotHeader

delete All Depot Header


/service/depots/csv/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/csv/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllCsvDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteAllCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllCsvDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteAllCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllCsvDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllCsvDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllCsvDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllCsvDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.deleteAllCsvDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllCsvDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->deleteAllCsvDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllCsvDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->deleteAllCsvDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_csv_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->deleteAllCsvDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteCsvDepot

delete Csv Depot


/service/depots/csv/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/csv/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCsvDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCsvDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// delete Csv Depot
[apiInstance deleteCsvDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCsvDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCsvDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Csv Depot
                apiInstance.deleteCsvDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.deleteCsvDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteCsvDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->deleteCsvDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteCsvDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->deleteCsvDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # delete Csv Depot
    api_instance.delete_csv_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->deleteCsvDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteCsvDepotFileByName

delete csv file by name


/service/depots/csv/{depotId}/remote_files

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/csv/{depotId}/remote_files?ctx=&fileName=&isTemp=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCsvDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvDepotFileByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCsvDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvDepotFileByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Boolean *isTemp = true; // isTemp
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// delete csv file by name
[apiInstance deleteCsvDepotFileByNameWith:ctx
    depotId:depotId
    fileName:fileName
    isTemp:isTemp
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var isTemp = true; // {{Boolean}} isTemp
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCsvDepotFileByName(ctx, depotId, fileName, isTemp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCsvDepotFileByNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var isTemp = true;  // Boolean | isTemp
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete csv file by name
                apiInstance.deleteCsvDepotFileByName(ctx, depotId, fileName, isTemp, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.deleteCsvDepotFileByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$isTemp = true; // Boolean | isTemp
$project = 789; // Long | Project id

try {
    $api_instance->deleteCsvDepotFileByName($ctx, $depotId, $fileName, $isTemp, $project);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->deleteCsvDepotFileByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $isTemp = true; # Boolean | isTemp
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteCsvDepotFileByName(ctx => $ctx, depotId => $depotId, fileName => $fileName, isTemp => $isTemp, project => $project);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->deleteCsvDepotFileByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
isTemp = true # Boolean | isTemp
project = 789 # Long | Project id (optional)

try: 
    # delete csv file by name
    api_instance.delete_csv_depot_file_by_name(ctx, depotId, fileName, isTemp, project=project)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->deleteCsvDepotFileByName: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
isTemp*
Boolean
isTemp
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteCsvDepotHeader

delete Depot Header


/service/depots/csv/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteCsvDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteCsvDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteCsvDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCsvDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCsvDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteCsvDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.deleteCsvDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteCsvDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->deleteCsvDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteCsvDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->deleteCsvDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_csv_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->deleteCsvDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteCsvExtraction

delete Extraction


/service/depots/csv/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/csv/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCsvExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteCsvExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteCsvExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCsvExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCsvExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteCsvExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.deleteCsvExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteCsvExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->deleteCsvExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteCsvExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->deleteCsvExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_csv_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->deleteCsvExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteCsvExtractionFilter

delete Extraction Filter


/service/depots/csv/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteCsvExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteCsvExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#deleteCsvExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteCsvExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCsvExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCsvExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteCsvExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.deleteCsvExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteCsvExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->deleteCsvExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteCsvExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->deleteCsvExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_csv_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->deleteCsvExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


detectCsvCharset

Detect csv depot charset

This operation is applied on a random file from the depots files


/service/depots/csv/{depotId}/charset

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/depots/csv/{depotId}/charset?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.detectCsvCharset(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#detectCsvCharset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.detectCsvCharset(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#detectCsvCharset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Detect csv depot charset
[apiInstance detectCsvCharsetWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.detectCsvCharset(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class detectCsvCharsetExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Detect csv depot charset
                'String' result = apiInstance.detectCsvCharset(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.detectCsvCharset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->detectCsvCharset($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->detectCsvCharset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->detectCsvCharset(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->detectCsvCharset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Detect csv depot charset
    api_response = api_instance.detect_csv_charset(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->detectCsvCharset: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


downloadLocalCsvFile

Download local CSV file


/service/depot/csv/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depot/csv/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalCsvFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#downloadLocalCsvFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalCsvFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#downloadLocalCsvFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Download local CSV file
[apiInstance downloadLocalCsvFileWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadLocalCsvFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadLocalCsvFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download local CSV file
                apiInstance.downloadLocalCsvFile(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.downloadLocalCsvFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadLocalCsvFile($token);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->downloadLocalCsvFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadLocalCsvFile(token => $token);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->downloadLocalCsvFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download local CSV file
    api_instance.download_local_csv_file(token=token)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->downloadLocalCsvFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editCsvDepot

edit Csv Depot


/service/depots/csv/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            CsvDepot result = apiInstance.editCsvDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#editCsvDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            CsvDepot result = apiInstance.editCsvDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#editCsvDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CsvDepot *body = ; // csvDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// edit Csv Depot
[apiInstance editCsvDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(CsvDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{CsvDepot}} csvDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editCsvDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editCsvDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new CsvDepot(); // CsvDepot | csvDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Csv Depot
                CsvDepot result = apiInstance.editCsvDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.editCsvDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // CsvDepot | csvDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editCsvDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->editCsvDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::CsvDepot->new(); # CsvDepot | csvDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editCsvDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->editCsvDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # CsvDepot | csvDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # edit Csv Depot
    api_response = api_instance.edit_csv_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->editCsvDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editCsvDepotHeader

edit Depot Header


/service/depots/csv/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editCsvDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#editCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editCsvDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#editCsvDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editCsvDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editCsvDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editCsvDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editCsvDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.editCsvDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editCsvDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->editCsvDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editCsvDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->editCsvDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_csv_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->editCsvDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editCsvExtractionFilter

edit Extraction Filter


/service/depots/csv/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editCsvExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#editCsvExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editCsvExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#editCsvExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editCsvExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editCsvExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editCsvExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editCsvExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.editCsvExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editCsvExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->editCsvExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editCsvExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->editCsvExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_csv_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->editCsvExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllCsvDepots

find All Csv Depots


/service/depots/csv

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[CsvDepot] result = apiInstance.findAllCsvDepots(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#findAllCsvDepots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[CsvDepot] result = apiInstance.findAllCsvDepots(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#findAllCsvDepots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// find All Csv Depots
[apiInstance findAllCsvDepotsWith:project
              completionHandler: ^(array[CsvDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllCsvDepots(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllCsvDepotsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Csv Depots
                array[CsvDepot] result = apiInstance.findAllCsvDepots(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.findAllCsvDepots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllCsvDepots($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->findAllCsvDepots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllCsvDepots(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->findAllCsvDepots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # find All Csv Depots
    api_response = api_instance.find_all_csv_depots(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->findAllCsvDepots: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllCsvExtractionFilters

find All Extraction Filters


/service/depots/csv/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllCsvExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#findAllCsvExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllCsvExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#findAllCsvExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllCsvExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllCsvExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllCsvExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllCsvExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.findAllCsvExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllCsvExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->findAllCsvExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllCsvExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->findAllCsvExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_csv_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->findAllCsvExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneCsvDepotById

find One Csv Depot By Id


/service/depots/csv/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            CsvDepot result = apiInstance.findOneCsvDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#findOneCsvDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            CsvDepot result = apiInstance.findOneCsvDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#findOneCsvDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// find One Csv Depot By Id
[apiInstance findOneCsvDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(CsvDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneCsvDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneCsvDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // find One Csv Depot By Id
                CsvDepot result = apiInstance.findOneCsvDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.findOneCsvDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneCsvDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->findOneCsvDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneCsvDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->findOneCsvDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # find One Csv Depot By Id
    api_response = api_instance.find_one_csv_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->findOneCsvDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCSVFileDownloadFileToken

Get download token for a local CSV file


/service/depot/csv/{depotId}/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/depot/csv/{depotId}/file/token?fileName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getCSVFileDownloadFileToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCSVFileDownloadFileToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getCSVFileDownloadFileToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCSVFileDownloadFileToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Get download token for a local CSV file
[apiInstance getCSVFileDownloadFileTokenWith:depotId
    fileName:fileName
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCSVFileDownloadFileToken(depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCSVFileDownloadFileTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get download token for a local CSV file
                'String' result = apiInstance.getCSVFileDownloadFileToken(depotId, fileName, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getCSVFileDownloadFileToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id

try {
    $result = $api_instance->getCSVFileDownloadFileToken($depotId, $fileName, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getCSVFileDownloadFileToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCSVFileDownloadFileToken(depotId => $depotId, fileName => $fileName, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getCSVFileDownloadFileToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)

try: 
    # Get download token for a local CSV file
    api_response = api_instance.get_csv_file_download_file_token(depotId, fileName, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getCSVFileDownloadFileToken: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
fileName*
String
fileName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCsvDepotExtractions

get Depot Extractions


/service/depots/csv/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getCsvDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getCsvDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getCsvDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCsvDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCsvDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getCsvDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getCsvDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getCsvDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getCsvDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCsvDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getCsvDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_csv_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getCsvDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCsvDepotFilesCount

Get csv depot files count


/service/depots/csv/{depotId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/count?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getCsvDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotFilesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getCsvDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotFilesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Get csv depot files count
[apiInstance getCsvDepotFilesCountWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCsvDepotFilesCount(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCsvDepotFilesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get csv depot files count
                Long result = apiInstance.getCsvDepotFilesCount(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getCsvDepotFilesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getCsvDepotFilesCount($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getCsvDepotFilesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCsvDepotFilesCount(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getCsvDepotFilesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get csv depot files count
    api_response = api_instance.get_csv_depot_files_count(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getCsvDepotFilesCount: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCsvDepotHeadersByDepotId

get Depot Headers By Depot Id


/service/depots/csv/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getCsvDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getCsvDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// get Depot Headers By Depot Id
[apiInstance getCsvDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCsvDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCsvDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By Depot Id
                array[DepotHeader] result = apiInstance.getCsvDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getCsvDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getCsvDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getCsvDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCsvDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getCsvDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By Depot Id
    api_response = api_instance.get_csv_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getCsvDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCsvDepotRemoteFiles

Get csv depot remoteFiles


/service/depots/csv/{depotId}/remote_files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/remote_files?ctx=&filenameMask=&includeTemp=&limit=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getCsvDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getCsvDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *filenameMask = filenameMask_example; // filenameMask
Boolean *includeTemp = true; // includeTemp
Integer *limit = 56; // limit
Long *project = 789; // Project id (optional)
String *remotePath = remotePath_example; // remotePath (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Get csv depot remoteFiles
[apiInstance getCsvDepotRemoteFilesWith:ctx
    depotId:depotId
    filenameMask:filenameMask
    includeTemp:includeTemp
    limit:limit
    project:project
    remotePath:remotePath
              completionHandler: ^(array[RemoteFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var filenameMask = filenameMask_example; // {{String}} filenameMask
var includeTemp = true; // {{Boolean}} includeTemp
var limit = 56; // {{Integer}} limit
var opts = { 
  'project': 789, // {{Long}} Project id
  'remotePath': remotePath_example // {{String}} remotePath
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCsvDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCsvDepotRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var filenameMask = filenameMask_example;  // String | filenameMask
            var includeTemp = true;  // Boolean | includeTemp
            var limit = 56;  // Integer | limit
            var project = 789;  // Long | Project id (optional) 
            var remotePath = remotePath_example;  // String | remotePath (optional) 

            try
            {
                // Get csv depot remoteFiles
                array[RemoteFile] result = apiInstance.getCsvDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getCsvDepotRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$filenameMask = filenameMask_example; // String | filenameMask
$includeTemp = true; // Boolean | includeTemp
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$remotePath = remotePath_example; // String | remotePath

try {
    $result = $api_instance->getCsvDepotRemoteFiles($ctx, $depotId, $filenameMask, $includeTemp, $limit, $project, $remotePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getCsvDepotRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $filenameMask = filenameMask_example; # String | filenameMask
my $includeTemp = true; # Boolean | includeTemp
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $remotePath = remotePath_example; # String | remotePath

eval { 
    my $result = $api_instance->getCsvDepotRemoteFiles(ctx => $ctx, depotId => $depotId, filenameMask => $filenameMask, includeTemp => $includeTemp, limit => $limit, project => $project, remotePath => $remotePath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getCsvDepotRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
filenameMask = filenameMask_example # String | filenameMask
includeTemp = true # Boolean | includeTemp
limit = 56 # Integer | limit
project = 789 # Long | Project id (optional)
remotePath = remotePath_example # String | remotePath (optional)

try: 
    # Get csv depot remoteFiles
    api_response = api_instance.get_csv_depot_remote_files(ctx, depotId, filenameMask, includeTemp, limit, project=project, remotePath=remotePath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getCsvDepotRemoteFiles: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filenameMask*
String
filenameMask
Required
includeTemp*
Boolean
includeTemp
Required
limit*
Integer (int32)
limit
Required
project
Long (int64)
Project id
remotePath
String
remotePath

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCsvExtractionFilePreview

get Extraction File Preview


/service/depots/csv/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getCsvExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getCsvExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getCsvExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getCsvExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCsvExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCsvExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getCsvExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getCsvExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getCsvExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getCsvExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getCsvExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getCsvExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_csv_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getCsvExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersFromCsvDepot

get Headers From Csv Depot


/service/depots/csv/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/headers?ctx=&inferSchema=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromCsvDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getHeadersFromCsvDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        CsvDepot body = ; // CsvDepot | csvDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromCsvDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#getHeadersFromCsvDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CsvDepot *body = ; // csvDepot
Integer *ctx = 56; // ctx
Boolean *inferSchema = true; // inferSchema (optional)
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// get Headers From Csv Depot
[apiInstance getHeadersFromCsvDepotWith:body
    ctx:ctx
    inferSchema:inferSchema
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{CsvDepot}} csvDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'inferSchema': true // {{Boolean}} inferSchema
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersFromCsvDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersFromCsvDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new CsvDepot(); // CsvDepot | csvDepot
            var ctx = 56;  // Integer | ctx
            var inferSchema = true;  // Boolean | inferSchema (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Headers From Csv Depot
                array[array[Object]] result = apiInstance.getHeadersFromCsvDepot(body, ctx, inferSchema, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.getHeadersFromCsvDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // CsvDepot | csvDepot
$ctx = 56; // Integer | ctx
$inferSchema = true; // Boolean | inferSchema
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHeadersFromCsvDepot($body, $ctx, $inferSchema, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->getHeadersFromCsvDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::CsvDepot->new(); # CsvDepot | csvDepot
my $ctx = 56; # Integer | ctx
my $inferSchema = true; # Boolean | inferSchema
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHeadersFromCsvDepot(body => $body, ctx => $ctx, inferSchema => $inferSchema, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->getHeadersFromCsvDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # CsvDepot | csvDepot
ctx = 56 # Integer | ctx
inferSchema = true # Boolean | inferSchema (optional)
project = 789 # Long | Project id (optional)

try: 
    # get Headers From Csv Depot
    api_response = api_instance.get_headers_from_csv_depot(body, ctx, inferSchema=inferSchema, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->getHeadersFromCsvDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
inferSchema
Boolean
inferSchema
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleCsvFileUpload

Upload csv file to a depot


/service/depots/csv/upload_file

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/upload_file?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleCsvFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#handleCsvFileUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleCsvFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#handleCsvFileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Upload csv file to a depot
[apiInstance handleCsvFileUploadWith:ctx
    project:project
              completionHandler: ^(FileUpload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleCsvFileUpload(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleCsvFileUploadExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Upload csv file to a depot
                FileUpload result = apiInstance.handleCsvFileUpload(ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.handleCsvFileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleCsvFileUpload($ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->handleCsvFileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleCsvFileUpload(ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->handleCsvFileUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Upload csv file to a depot
    api_response = api_instance.handle_csv_file_upload(ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->handleCsvFileUpload: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveCsvDepotTempFolderOnTypeUpdate

move temp folder when type is changed


/service/depots/csv/move_tmp_folder_on_type_update

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/csv/move_tmp_folder_on_type_update?ctx=&depotCode=&newDepotType=&oldDepotType=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveCsvDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#moveCsvDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveCsvDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#moveCsvDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *depotCode = depotCode_example; // depotCode
String *newDepotType = newDepotType_example; // newDepotType
String *oldDepotType = oldDepotType_example; // oldDepotType
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// move temp folder when type is changed
[apiInstance moveCsvDepotTempFolderOnTypeUpdateWith:ctx
    depotCode:depotCode
    newDepotType:newDepotType
    oldDepotType:oldDepotType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotCode = depotCode_example; // {{String}} depotCode
var newDepotType = newDepotType_example; // {{String}} newDepotType
var oldDepotType = oldDepotType_example; // {{String}} oldDepotType
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveCsvDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveCsvDepotTempFolderOnTypeUpdateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotCode = depotCode_example;  // String | depotCode
            var newDepotType = newDepotType_example;  // String | newDepotType
            var oldDepotType = oldDepotType_example;  // String | oldDepotType
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // move temp folder when type is changed
                apiInstance.moveCsvDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.moveCsvDepotTempFolderOnTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotCode = depotCode_example; // String | depotCode
$newDepotType = newDepotType_example; // String | newDepotType
$oldDepotType = oldDepotType_example; // String | oldDepotType
$project = 789; // Long | Project id

try {
    $api_instance->moveCsvDepotTempFolderOnTypeUpdate($ctx, $depotCode, $newDepotType, $oldDepotType, $project);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->moveCsvDepotTempFolderOnTypeUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotCode = depotCode_example; # String | depotCode
my $newDepotType = newDepotType_example; # String | newDepotType
my $oldDepotType = oldDepotType_example; # String | oldDepotType
my $project = 789; # Long | Project id

eval { 
    $api_instance->moveCsvDepotTempFolderOnTypeUpdate(ctx => $ctx, depotCode => $depotCode, newDepotType => $newDepotType, oldDepotType => $oldDepotType, project => $project);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->moveCsvDepotTempFolderOnTypeUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotCode = depotCode_example # String | depotCode
newDepotType = newDepotType_example # String | newDepotType
oldDepotType = oldDepotType_example # String | oldDepotType
project = 789 # Long | Project id (optional)

try: 
    # move temp folder when type is changed
    api_instance.move_csv_depot_temp_folder_on_type_update(ctx, depotCode, newDepotType, oldDepotType, project=project)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->moveCsvDepotTempFolderOnTypeUpdate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotCode*
String
depotCode
Required
newDepotType*
String
newDepotType
Required
oldDepotType*
String
oldDepotType
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


previewDepotCsvFile

Get csv depot preview


/service/depots/csv/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.previewDepotCsvFile(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#previewDepotCsvFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.previewDepotCsvFile(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#previewDepotCsvFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Get csv depot preview
[apiInstance previewDepotCsvFileWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewDepotCsvFile(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewDepotCsvFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get csv depot preview
                DepotData result = apiInstance.previewDepotCsvFile(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.previewDepotCsvFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->previewDepotCsvFile($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->previewDepotCsvFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->previewDepotCsvFile(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->previewDepotCsvFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get csv depot preview
    api_response = api_instance.preview_depot_csv_file(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->previewDepotCsvFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


previewRemoteCsvFile

Get csv depot file preview


/service/depots/csv/{depotId}/remote_files/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/csv/{depotId}/remote_files/preview?ctx=&fileName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteCsvFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#previewRemoteCsvFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteCsvFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#previewRemoteCsvFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// Get csv depot file preview
[apiInstance previewRemoteCsvFileWith:ctx
    depotId:depotId
    fileName:fileName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewRemoteCsvFile(ctx, depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewRemoteCsvFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Get csv depot file preview
                DepotData result = apiInstance.previewRemoteCsvFile(ctx, depotId, fileName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.previewRemoteCsvFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->previewRemoteCsvFile($ctx, $depotId, $fileName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->previewRemoteCsvFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->previewRemoteCsvFile(ctx => $ctx, depotId => $depotId, fileName => $fileName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->previewRemoteCsvFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Get csv depot file preview
    api_response = api_instance.preview_remote_csv_file(ctx, depotId, fileName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->previewRemoteCsvFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateCsvDepotActivationStatus

update Depot Activation Status


/service/depots/csv/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/csv/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateCsvDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#updateCsvDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateCsvDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#updateCsvDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateCsvDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCsvDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCsvDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateCsvDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.updateCsvDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateCsvDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->updateCsvDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateCsvDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->updateCsvDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_csv_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->updateCsvDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateCsvDepotHeadersPositions

update Depot Headers Positions


/service/depots/csv/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/csv/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CsvDepotControllerApi;

import java.io.File;
import java.util.*;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateCsvDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#updateCsvDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CsvDepotControllerApi;

public class CsvDepotControllerApiExample {

    public static void main(String[] args) {
        CsvDepotControllerApi apiInstance = new CsvDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateCsvDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling CsvDepotControllerApi#updateCsvDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

CsvDepotControllerApi *apiInstance = [[CsvDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateCsvDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.CsvDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCsvDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCsvDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CsvDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateCsvDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CsvDepotControllerApi.updateCsvDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCsvDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateCsvDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling CsvDepotControllerApi->updateCsvDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CsvDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CsvDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateCsvDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling CsvDepotControllerApi->updateCsvDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CsvDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_csv_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling CsvDepotControllerApi->updateCsvDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


DashboardController

createDashboard

Create a new dashboard

Create a new dashboard and returns the new generated Id


/service/dashboards

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboards?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        CreateDashboardEntry body = ; // CreateDashboardEntry | New dashboard data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createDashboard(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#createDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        CreateDashboardEntry body = ; // CreateDashboardEntry | New dashboard data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createDashboard(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#createDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateDashboardEntry *body = ; // New dashboard data
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Create a new dashboard
[apiInstance createDashboardWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var body = ; // {{CreateDashboardEntry}} New dashboard data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDashboard(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDashboardExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var body = new CreateDashboardEntry(); // CreateDashboardEntry | New dashboard data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new dashboard
                Long result = apiInstance.createDashboard(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.createDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$body = ; // CreateDashboardEntry | New dashboard data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createDashboard($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->createDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateDashboardEntry->new(); # CreateDashboardEntry | New dashboard data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createDashboard(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->createDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
body =  # CreateDashboardEntry | New dashboard data
project = 789 # Long | Project id (optional)

try: 
    # Create a new dashboard
    api_response = api_instance.create_dashboard(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->createDashboard: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteBulkDashboard

Delete a list of charts


/service/dashboards

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/dashboards?ids=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        array[Long] ids = ; // array[Long] | Requested chart Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkDashboard(ids, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#deleteBulkDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        array[Long] ids = ; // array[Long] | Requested chart Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkDashboard(ids, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#deleteBulkDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *ids = ; // Requested chart Ids
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Delete a list of charts
[apiInstance deleteBulkDashboardWith:ids
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var ids = ; // {{array[Long]}} Requested chart Ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBulkDashboard(ids, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBulkDashboardExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var ids = new array[Long](); // array[Long] | Requested chart Ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of charts
                apiInstance.deleteBulkDashboard(ids, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.deleteBulkDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$ids = ; // array[Long] | Requested chart Ids
$project = 789; // Long | Project id

try {
    $api_instance->deleteBulkDashboard($ids, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->deleteBulkDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $ids = []; # array[Long] | Requested chart Ids
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBulkDashboard(ids => $ids, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->deleteBulkDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
ids =  # array[Long] | Requested chart Ids
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of charts
    api_instance.delete_bulk_dashboard(ids, project=project)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->deleteBulkDashboard: %s\n" % e)

Parameters

Query parameters
Name Description
ids*
array[Long] (int64)
Requested chart Ids
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteDashboard

Delete an existing dashboard


/service/dashboards/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/dashboards/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long id = 789; // Long | The Id of the dashboard to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDashboard(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#deleteDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long id = 789; // Long | The Id of the dashboard to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDashboard(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#deleteDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the dashboard to be deleted
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Delete an existing dashboard
[apiInstance deleteDashboardWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var id = 789; // {{Long}} The Id of the dashboard to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDashboard(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDashboardExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var id = 789;  // Long | The Id of the dashboard to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing dashboard
                apiInstance.deleteDashboard(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.deleteDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$id = 789; // Long | The Id of the dashboard to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteDashboard($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->deleteDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $id = 789; # Long | The Id of the dashboard to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDashboard(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->deleteDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
id = 789 # Long | The Id of the dashboard to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing dashboard
    api_instance.delete_dashboard(id, project=project)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->deleteDashboard: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the dashboard to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDashboard

Edit dashboard

Edit an existing dashboard


/service/dashboards/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboards/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        UpdateDashboardEntry body = ; // UpdateDashboardEntry | Update dashboard data
        Long id = 789; // Long | Id of dashboard to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editDashboard(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#editDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        UpdateDashboardEntry body = ; // UpdateDashboardEntry | Update dashboard data
        Long id = 789; // Long | Id of dashboard to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editDashboard(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#editDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateDashboardEntry *body = ; // Update dashboard data
Long *id = 789; // Id of dashboard to update data
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Edit dashboard
[apiInstance editDashboardWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var body = ; // {{UpdateDashboardEntry}} Update dashboard data
var id = 789; // {{Long}} Id of dashboard to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editDashboard(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDashboardExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var body = new UpdateDashboardEntry(); // UpdateDashboardEntry | Update dashboard data
            var id = 789;  // Long | Id of dashboard to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit dashboard
                apiInstance.editDashboard(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.editDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$body = ; // UpdateDashboardEntry | Update dashboard data
$id = 789; // Long | Id of dashboard to update data
$project = 789; // Long | Project id

try {
    $api_instance->editDashboard($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->editDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateDashboardEntry->new(); # UpdateDashboardEntry | Update dashboard data
my $id = 789; # Long | Id of dashboard to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editDashboard(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->editDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
body =  # UpdateDashboardEntry | Update dashboard data
id = 789 # Long | Id of dashboard to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit dashboard
    api_instance.edit_dashboard(body, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->editDashboard: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of dashboard to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDashboardConfig

Update the configuration informations of an existing dashboard


/service/dashboards/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboards/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        UpdateDashboardConfigEntry body = ; // UpdateDashboardConfigEntry | The update configuration data
        Long id = 789; // Long | HdDashboard Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editDashboardConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#editDashboardConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        UpdateDashboardConfigEntry body = ; // UpdateDashboardConfigEntry | The update configuration data
        Long id = 789; // Long | HdDashboard Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editDashboardConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#editDashboardConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateDashboardConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdDashboard Id
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Update the configuration informations of an existing dashboard
[apiInstance editDashboardConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var body = ; // {{UpdateDashboardConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdDashboard Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editDashboardConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDashboardConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var body = new UpdateDashboardConfigEntry(); // UpdateDashboardConfigEntry | The update configuration data
            var id = 789;  // Long | HdDashboard Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing dashboard
                apiInstance.editDashboardConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.editDashboardConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$body = ; // UpdateDashboardConfigEntry | The update configuration data
$id = 789; // Long | HdDashboard Id
$project = 789; // Long | Project id

try {
    $api_instance->editDashboardConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->editDashboardConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateDashboardConfigEntry->new(); # UpdateDashboardConfigEntry | The update configuration data
my $id = 789; # Long | HdDashboard Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editDashboardConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->editDashboardConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
body =  # UpdateDashboardConfigEntry | The update configuration data
id = 789 # Long | HdDashboard Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing dashboard
    api_instance.edit_dashboard_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->editDashboardConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdDashboard Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getAllDashboards

Get a list of the available dashboards


/service/dashboards

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdDashboard] result = apiInstance.getAllDashboards(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getAllDashboards");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdDashboard] result = apiInstance.getAllDashboards(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getAllDashboards");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Get a list of the available dashboards
[apiInstance getAllDashboardsWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[HdDashboard] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllDashboards(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllDashboardsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of the available dashboards
                array[HdDashboard] result = apiInstance.getAllDashboards(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.getAllDashboards: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllDashboards($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->getAllDashboards: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllDashboards(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->getAllDashboards: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of the available dashboards
    api_response = api_instance.get_all_dashboards(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->getAllDashboards: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDashboard

Get a dashboard by Id


/service/dashboards/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long id = 789; // Long | Requested dashboard Id
        Long project = 789; // Long | Project id
        try {
            HdDashboard result = apiInstance.getDashboard(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long id = 789; // Long | Requested dashboard Id
        Long project = 789; // Long | Project id
        try {
            HdDashboard result = apiInstance.getDashboard(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested dashboard Id
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Get a dashboard by Id
[apiInstance getDashboardWith:id
    project:project
              completionHandler: ^(HdDashboard output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var id = 789; // {{Long}} Requested dashboard Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboard(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDashboardExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var id = 789;  // Long | Requested dashboard Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a dashboard by Id
                HdDashboard result = apiInstance.getDashboard(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.getDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$id = 789; // Long | Requested dashboard Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDashboard($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->getDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $id = 789; # Long | Requested dashboard Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDashboard(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->getDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
id = 789 # Long | Requested dashboard Id
project = 789 # Long | Project id (optional)

try: 
    # Get a dashboard by Id
    api_response = api_instance.get_dashboard(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->getDashboard: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested dashboard Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDashboardConfig

Get the configuration informations of an existing dashboard


/service/dashboards/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long id = 789; // Long | HdDashboard Id
        Long project = 789; // Long | Project id
        try {
            DashboardConfig result = apiInstance.getDashboardConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getDashboardConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long id = 789; // Long | HdDashboard Id
        Long project = 789; // Long | Project id
        try {
            DashboardConfig result = apiInstance.getDashboardConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getDashboardConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdDashboard Id
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Get the configuration informations of an existing dashboard
[apiInstance getDashboardConfigWith:id
    project:project
              completionHandler: ^(DashboardConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var id = 789; // {{Long}} HdDashboard Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDashboardConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var id = 789;  // Long | HdDashboard Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing dashboard
                DashboardConfig result = apiInstance.getDashboardConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.getDashboardConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$id = 789; // Long | HdDashboard Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDashboardConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->getDashboardConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $id = 789; # Long | HdDashboard Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDashboardConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->getDashboardConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
id = 789 # Long | HdDashboard Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing dashboard
    api_response = api_instance.get_dashboard_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->getDashboardConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdDashboard Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDashboardElementsForMove

Get dashboard linked element for move/copy


/service/dashboards/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Dashboard ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getDashboardElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getDashboardElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Dashboard ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getDashboardElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#getDashboardElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Dashboard ID (optional)
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Get dashboard linked element for move/copy
[apiInstance getDashboardElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Dashboard ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDashboardElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Dashboard ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get dashboard linked element for move/copy
                array[DcUsedElement] result = apiInstance.getDashboardElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.getDashboardElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Dashboard ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDashboardElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->getDashboardElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Dashboard ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDashboardElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->getDashboardElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Dashboard ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get dashboard linked element for move/copy
    api_response = api_instance.get_dashboard_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->getDashboardElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Dashboard ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveDashboardElements

Move Dashboard and linked elements to another project


/service/dashboards/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardControllerApi;

import java.io.File;
import java.util.*;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Dashboard ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveDashboardElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#moveDashboardElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardControllerApi;

public class DashboardControllerApiExample {

    public static void main(String[] args) {
        DashboardControllerApi apiInstance = new DashboardControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Dashboard ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveDashboardElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardControllerApi#moveDashboardElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Dashboard ID (optional)
Long *project = 789; // Project id (optional)

DashboardControllerApi *apiInstance = [[DashboardControllerApi alloc] init];

// Move Dashboard and linked elements to another project
[apiInstance moveDashboardElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Dashboard ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveDashboardElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveDashboardElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Dashboard ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move Dashboard and linked elements to another project
                DcMoveResponse result = apiInstance.moveDashboardElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardControllerApi.moveDashboardElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Dashboard ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveDashboardElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardControllerApi->moveDashboardElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Dashboard ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveDashboardElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardControllerApi->moveDashboardElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Dashboard ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move Dashboard and linked elements to another project
    api_response = api_instance.move_dashboard_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardControllerApi->moveDashboardElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Dashboard ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DashboardPublicationController

createPublication

Create a new publication

Create a new publication and returns the new generated Id


/service/dashboards/{dashId}/publications

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboards/{dashId}/publications?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        CreatePublicationEntry body = ; // CreatePublicationEntry | New publication data
        Long dashId = 789; // Long | Requested dashboard Id
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPublication(body, dashId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#createPublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        CreatePublicationEntry body = ; // CreatePublicationEntry | New publication data
        Long dashId = 789; // Long | Requested dashboard Id
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPublication(body, dashId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#createPublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreatePublicationEntry *body = ; // New publication data
Long *dashId = 789; // Requested dashboard Id
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Create a new publication
[apiInstance createPublicationWith:body
    dashId:dashId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var body = ; // {{CreatePublicationEntry}} New publication data
var dashId = 789; // {{Long}} Requested dashboard Id
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPublication(bodydashId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var body = new CreatePublicationEntry(); // CreatePublicationEntry | New publication data
            var dashId = 789;  // Long | Requested dashboard Id
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new publication
                Long result = apiInstance.createPublication(body, dashId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.createPublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$body = ; // CreatePublicationEntry | New publication data
$dashId = 789; // Long | Requested dashboard Id
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->createPublication($body, $dashId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->createPublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreatePublicationEntry->new(); # CreatePublicationEntry | New publication data
my $dashId = 789; # Long | Requested dashboard Id
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createPublication(body => $body, dashId => $dashId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->createPublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
body =  # CreatePublicationEntry | New publication data
dashId = 789 # Long | Requested dashboard Id
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Create a new publication
    api_response = api_instance.create_publication(body, dashId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->createPublication: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Requested dashboard Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteOrArchivePublication

Delete or archive an existing publication


/service/dashboards/{dashId}/publications/{id}/delete_or_archive

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/dashboards/{dashId}/publications/{id}/delete_or_archive?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | The Id of the dashboard
        Long id = 789; // Long | The Id of the publication to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteOrArchivePublication(dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#deleteOrArchivePublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | The Id of the dashboard
        Long id = 789; // Long | The Id of the publication to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteOrArchivePublication(dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#deleteOrArchivePublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // The Id of the dashboard
Long *id = 789; // The Id of the publication to be deleted
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Delete or archive an existing publication
[apiInstance deleteOrArchivePublicationWith:dashId
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} The Id of the dashboard
var id = 789; // {{Long}} The Id of the publication to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteOrArchivePublication(dashId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteOrArchivePublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | The Id of the dashboard
            var id = 789;  // Long | The Id of the publication to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete or archive an existing publication
                apiInstance.deleteOrArchivePublication(dashId, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.deleteOrArchivePublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | The Id of the dashboard
$id = 789; // Long | The Id of the publication to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteOrArchivePublication($dashId, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->deleteOrArchivePublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | The Id of the dashboard
my $id = 789; # Long | The Id of the publication to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteOrArchivePublication(dashId => $dashId, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->deleteOrArchivePublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | The Id of the dashboard
id = 789 # Long | The Id of the publication to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete or archive an existing publication
    api_instance.delete_or_archive_publication(dashId, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->deleteOrArchivePublication: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
The Id of the dashboard
Required
id*
Long (int64)
The Id of the publication to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deletePublication

Delete an existing publication


/service/dashboards/{dashId}/publications/{id}/delete

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/dashboards/{dashId}/publications/{id}/delete?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | The Id of the dashboard
        Long id = 789; // Long | The Id of the publication to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePublication(dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#deletePublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | The Id of the dashboard
        Long id = 789; // Long | The Id of the publication to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePublication(dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#deletePublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // The Id of the dashboard
Long *id = 789; // The Id of the publication to be deleted
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Delete an existing publication
[apiInstance deletePublicationWith:dashId
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} The Id of the dashboard
var id = 789; // {{Long}} The Id of the publication to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePublication(dashId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | The Id of the dashboard
            var id = 789;  // Long | The Id of the publication to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing publication
                apiInstance.deletePublication(dashId, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.deletePublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | The Id of the dashboard
$id = 789; // Long | The Id of the publication to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deletePublication($dashId, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->deletePublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | The Id of the dashboard
my $id = 789; # Long | The Id of the publication to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deletePublication(dashId => $dashId, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->deletePublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | The Id of the dashboard
id = 789 # Long | The Id of the publication to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing publication
    api_instance.delete_publication(dashId, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->deletePublication: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
The Id of the dashboard
Required
id*
Long (int64)
The Id of the publication to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editPublication

Edit publication

Edit an existing publication


/service/dashboards/{dashId}/publications/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboards/{dashId}/publications/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        UpdatePublicationEntry body = ; // UpdatePublicationEntry | Update publication data
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPublication(body, dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#editPublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        UpdatePublicationEntry body = ; // UpdatePublicationEntry | Update publication data
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPublication(body, dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#editPublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdatePublicationEntry *body = ; // Update publication data
Long *dashId = 789; // Id of dashboard
Long *id = 789; // Id of publication to update data
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Edit publication
[apiInstance editPublicationWith:body
    dashId:dashId
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var body = ; // {{UpdatePublicationEntry}} Update publication data
var dashId = 789; // {{Long}} Id of dashboard
var id = 789; // {{Long}} Id of publication to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editPublication(bodydashIdid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var body = new UpdatePublicationEntry(); // UpdatePublicationEntry | Update publication data
            var dashId = 789;  // Long | Id of dashboard
            var id = 789;  // Long | Id of publication to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit publication
                apiInstance.editPublication(body, dashId, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.editPublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$body = ; // UpdatePublicationEntry | Update publication data
$dashId = 789; // Long | Id of dashboard
$id = 789; // Long | Id of publication to update data
$project = 789; // Long | Project id

try {
    $api_instance->editPublication($body, $dashId, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->editPublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePublicationEntry->new(); # UpdatePublicationEntry | Update publication data
my $dashId = 789; # Long | Id of dashboard
my $id = 789; # Long | Id of publication to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editPublication(body => $body, dashId => $dashId, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->editPublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
body =  # UpdatePublicationEntry | Update publication data
dashId = 789 # Long | Id of dashboard
id = 789 # Long | Id of publication to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit publication
    api_instance.edit_publication(body, dashId, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->editPublication: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
id*
Long (int64)
Id of publication to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getAllPublications

Get a list of publications of a dashboard


/service/dashboards/{dashId}/publications

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{dashId}/publications?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long project = 789; // Long | Project id
        try {
            array[HdDashboardPublication] result = apiInstance.getAllPublications(dashId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getAllPublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long project = 789; // Long | Project id
        try {
            array[HdDashboardPublication] result = apiInstance.getAllPublications(dashId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getAllPublications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // Id of dashboard
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Get a list of publications of a dashboard
[apiInstance getAllPublicationsWith:dashId
    project:project
              completionHandler: ^(array[HdDashboardPublication] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} Id of dashboard
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllPublications(dashId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllPublicationsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | Id of dashboard
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of publications of a dashboard
                array[HdDashboardPublication] result = apiInstance.getAllPublications(dashId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.getAllPublications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | Id of dashboard
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllPublications($dashId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->getAllPublications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | Id of dashboard
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllPublications(dashId => $dashId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->getAllPublications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | Id of dashboard
project = 789 # Long | Project id (optional)

try: 
    # Get a list of publications of a dashboard
    api_response = api_instance.get_all_publications(dashId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->getAllPublications: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDashboardDataUsingPOST

getDashboardData


/service/dashboard_publication/{link}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboard_publication/{link}?applyInitialCenterings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        array[CenteringData] body = ; // array[CenteringData] | centerings
        Boolean applyInitialCenterings = true; // Boolean | applyInitialCenterings
        String link = link_example; // String | link
        try {
            DashboardPublic result = apiInstance.getDashboardDataUsingPOST(body, applyInitialCenterings, link);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getDashboardDataUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        array[CenteringData] body = ; // array[CenteringData] | centerings
        Boolean applyInitialCenterings = true; // Boolean | applyInitialCenterings
        String link = link_example; // String | link
        try {
            DashboardPublic result = apiInstance.getDashboardDataUsingPOST(body, applyInitialCenterings, link);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getDashboardDataUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[CenteringData] *body = ; // centerings
Boolean *applyInitialCenterings = true; // applyInitialCenterings
String *link = link_example; // link

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// getDashboardData
[apiInstance getDashboardDataUsingPOSTWith:body
    applyInitialCenterings:applyInitialCenterings
    link:link
              completionHandler: ^(DashboardPublic output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var body = ; // {{array[CenteringData]}} centerings
var applyInitialCenterings = true; // {{Boolean}} applyInitialCenterings
var link = link_example; // {{String}} link

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardDataUsingPOST(bodyapplyInitialCenteringslink, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDashboardDataUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var body = new array[CenteringData](); // array[CenteringData] | centerings
            var applyInitialCenterings = true;  // Boolean | applyInitialCenterings
            var link = link_example;  // String | link

            try
            {
                // getDashboardData
                DashboardPublic result = apiInstance.getDashboardDataUsingPOST(body, applyInitialCenterings, link);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.getDashboardDataUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$body = ; // array[CenteringData] | centerings
$applyInitialCenterings = true; // Boolean | applyInitialCenterings
$link = link_example; // String | link

try {
    $result = $api_instance->getDashboardDataUsingPOST($body, $applyInitialCenterings, $link);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->getDashboardDataUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[CenteringData]->new()]; # array[CenteringData] | centerings
my $applyInitialCenterings = true; # Boolean | applyInitialCenterings
my $link = link_example; # String | link

eval { 
    my $result = $api_instance->getDashboardDataUsingPOST(body => $body, applyInitialCenterings => $applyInitialCenterings, link => $link);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->getDashboardDataUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
body =  # array[CenteringData] | centerings
applyInitialCenterings = true # Boolean | applyInitialCenterings
link = link_example # String | link

try: 
    # getDashboardData
    api_response = api_instance.get_dashboard_data_using_post(body, applyInitialCenterings, link)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->getDashboardDataUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
link*
Body parameters
Name Description
body *
Query parameters
Name Description
applyInitialCenterings*
Boolean
applyInitialCenterings
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getPublicationById

Get a publications by id


/service/dashboards/{dashId}/publications/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{dashId}/publications/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication
        Long project = 789; // Long | Project id
        try {
            PublicationData result = apiInstance.getPublicationById(dashId, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication
        Long project = 789; // Long | Project id
        try {
            PublicationData result = apiInstance.getPublicationById(dashId, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // Id of dashboard
Long *id = 789; // Id of publication
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Get a publications by id
[apiInstance getPublicationByIdWith:dashId
    id:id
    project:project
              completionHandler: ^(PublicationData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} Id of dashboard
var id = 789; // {{Long}} Id of publication
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicationById(dashId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicationByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | Id of dashboard
            var id = 789;  // Long | Id of publication
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a publications by id
                PublicationData result = apiInstance.getPublicationById(dashId, id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.getPublicationById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | Id of dashboard
$id = 789; // Long | Id of publication
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPublicationById($dashId, $id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->getPublicationById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | Id of dashboard
my $id = 789; # Long | Id of publication
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPublicationById(dashId => $dashId, id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->getPublicationById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | Id of dashboard
id = 789 # Long | Id of publication
project = 789 # Long | Project id (optional)

try: 
    # Get a publications by id
    api_response = api_instance.get_publication_by_id(dashId, id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->getPublicationById: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
id*
Long (int64)
Id of publication
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getPublicationHashById

Get a publication Hash link


/service/dashboards/{dashId}/publications/generate_link

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/dashboards/{dashId}/publications/generate_link?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getPublicationHashById(dashId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationHashById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getPublicationHashById(dashId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationHashById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // Id of dashboard
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Get a publication Hash link
[apiInstance getPublicationHashByIdWith:dashId
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} Id of dashboard
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicationHashById(dashId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicationHashByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | Id of dashboard
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a publication Hash link
                'String' result = apiInstance.getPublicationHashById(dashId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.getPublicationHashById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | Id of dashboard
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPublicationHashById($dashId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->getPublicationHashById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | Id of dashboard
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPublicationHashById(dashId => $dashId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->getPublicationHashById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | Id of dashboard
project = 789 # Long | Project id (optional)

try: 
    # Get a publication Hash link
    api_response = api_instance.get_publication_hash_by_id(dashId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->getPublicationHashById: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getPublicationLinkUsingGET

getPublicationLink


/service/dashboard_publication/link

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/dashboard_publication/link"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        try {
            'String' result = apiInstance.getPublicationLinkUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationLinkUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        try {
            'String' result = apiInstance.getPublicationLinkUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationLinkUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// getPublicationLink
[apiInstance getPublicationLinkUsingGETWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicationLinkUsingGET(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicationLinkUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();

            try
            {
                // getPublicationLink
                'String' result = apiInstance.getPublicationLinkUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.getPublicationLinkUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();

try {
    $result = $api_instance->getPublicationLinkUsingGET();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->getPublicationLinkUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();

eval { 
    my $result = $api_instance->getPublicationLinkUsingGET();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->getPublicationLinkUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()

try: 
    # getPublicationLink
    api_response = api_instance.get_publication_link_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->getPublicationLinkUsingGET: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getPublicationViews

Get a list of view of publications of a dashboard


/service/dashboards/{dashId}/publications/{id}/views

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{dashId}/publications/{id}/views?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication
        Long project = 789; // Long | Project id
        try {
            array[HdPublicationView] result = apiInstance.getPublicationViews(dashId, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationViews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication
        Long project = 789; // Long | Project id
        try {
            array[HdPublicationView] result = apiInstance.getPublicationViews(dashId, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#getPublicationViews");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // Id of dashboard
Long *id = 789; // Id of publication
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Get a list of view of publications of a dashboard
[apiInstance getPublicationViewsWith:dashId
    id:id
    project:project
              completionHandler: ^(array[HdPublicationView] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} Id of dashboard
var id = 789; // {{Long}} Id of publication
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicationViews(dashId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicationViewsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | Id of dashboard
            var id = 789;  // Long | Id of publication
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of view of publications of a dashboard
                array[HdPublicationView] result = apiInstance.getPublicationViews(dashId, id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.getPublicationViews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | Id of dashboard
$id = 789; // Long | Id of publication
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPublicationViews($dashId, $id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->getPublicationViews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | Id of dashboard
my $id = 789; # Long | Id of publication
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPublicationViews(dashId => $dashId, id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->getPublicationViews: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | Id of dashboard
id = 789 # Long | Id of publication
project = 789 # Long | Project id (optional)

try: 
    # Get a list of view of publications of a dashboard
    api_response = api_instance.get_publication_views(dashId, id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->getPublicationViews: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
id*
Long (int64)
Id of publication
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


restorePublication

Restore publication

Restore a deleted publication


/service/dashboards/{dashId}/publications/{id}/restore

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{dashId}/publications/{id}/restore?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.restorePublication(dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#restorePublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.restorePublication(dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#restorePublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // Id of dashboard
Long *id = 789; // Id of publication to update data
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Restore publication
[apiInstance restorePublicationWith:dashId
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} Id of dashboard
var id = 789; // {{Long}} Id of publication to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restorePublication(dashId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restorePublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | Id of dashboard
            var id = 789;  // Long | Id of publication to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Restore publication
                apiInstance.restorePublication(dashId, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.restorePublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | Id of dashboard
$id = 789; // Long | Id of publication to update data
$project = 789; // Long | Project id

try {
    $api_instance->restorePublication($dashId, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->restorePublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | Id of dashboard
my $id = 789; # Long | Id of publication to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->restorePublication(dashId => $dashId, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->restorePublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | Id of dashboard
id = 789 # Long | Id of publication to update data
project = 789 # Long | Project id (optional)

try: 
    # Restore publication
    api_instance.restore_publication(dashId, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->restorePublication: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
id*
Long (int64)
Id of publication to update data
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updatePublication

Update publication

Update an existing publication


/service/dashboards/{dashId}/publications/{id}/update

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dashboards/{dashId}/publications/{id}/update?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.updatePublication(dashId, id, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#updatePublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.updatePublication(dashId, id, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#updatePublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *dashId = 789; // Id of dashboard
Long *id = 789; // Id of publication to update data
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Update publication
[apiInstance updatePublicationWith:dashId
    id:id
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var dashId = 789; // {{Long}} Id of dashboard
var id = 789; // {{Long}} Id of publication to update data
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePublication(dashId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var dashId = 789;  // Long | Id of dashboard
            var id = 789;  // Long | Id of publication to update data
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update publication
                apiInstance.updatePublication(dashId, id, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.updatePublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$dashId = 789; // Long | Id of dashboard
$id = 789; // Long | Id of publication to update data
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->updatePublication($dashId, $id, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->updatePublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $dashId = 789; # Long | Id of dashboard
my $id = 789; # Long | Id of publication to update data
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->updatePublication(dashId => $dashId, id => $id, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->updatePublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
dashId = 789 # Long | Id of dashboard
id = 789 # Long | Id of publication to update data
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Update publication
    api_instance.update_publication(dashId, id, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->updatePublication: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
id*
Long (int64)
Id of publication to update data
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updatePublicationStatus

Update publication status

Edit an existing publication


/service/dashboards/{dashId}/publications/{id}/status

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboards/{dashId}/publications/{id}/status?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardPublicationControllerApi;

import java.io.File;
import java.util.*;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Boolean body = ; // Boolean | Update publication data
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.updatePublicationStatus(body, dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#updatePublicationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardPublicationControllerApi;

public class DashboardPublicationControllerApiExample {

    public static void main(String[] args) {
        DashboardPublicationControllerApi apiInstance = new DashboardPublicationControllerApi();
        Boolean body = ; // Boolean | Update publication data
        Long dashId = 789; // Long | Id of dashboard
        Long id = 789; // Long | Id of publication to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.updatePublicationStatus(body, dashId, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardPublicationControllerApi#updatePublicationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *body = ; // Update publication data
Long *dashId = 789; // Id of dashboard
Long *id = 789; // Id of publication to update data
Long *project = 789; // Project id (optional)

DashboardPublicationControllerApi *apiInstance = [[DashboardPublicationControllerApi alloc] init];

// Update publication status
[apiInstance updatePublicationStatusWith:body
    dashId:dashId
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DashboardPublicationControllerApi()
var body = ; // {{Boolean}} Update publication data
var dashId = 789; // {{Long}} Id of dashboard
var id = 789; // {{Long}} Id of publication to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePublicationStatus(bodydashIdid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePublicationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DashboardPublicationControllerApi();
            var body = new Boolean(); // Boolean | Update publication data
            var dashId = 789;  // Long | Id of dashboard
            var id = 789;  // Long | Id of publication to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update publication status
                apiInstance.updatePublicationStatus(body, dashId, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardPublicationControllerApi.updatePublicationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDashboardPublicationControllerApi();
$body = ; // Boolean | Update publication data
$dashId = 789; // Long | Id of dashboard
$id = 789; // Long | Id of publication to update data
$project = 789; // Long | Project id

try {
    $api_instance->updatePublicationStatus($body, $dashId, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling DashboardPublicationControllerApi->updatePublicationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardPublicationControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DashboardPublicationControllerApi->new();
my $body = WWW::SwaggerClient::Object::Boolean->new(); # Boolean | Update publication data
my $dashId = 789; # Long | Id of dashboard
my $id = 789; # Long | Id of publication to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->updatePublicationStatus(body => $body, dashId => $dashId, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling DashboardPublicationControllerApi->updatePublicationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DashboardPublicationControllerApi()
body =  # Boolean | Update publication data
dashId = 789 # Long | Id of dashboard
id = 789 # Long | Id of publication to update data
project = 789 # Long | Project id (optional)

try: 
    # Update publication status
    api_instance.update_publication_status(body, dashId, id, project=project)
except ApiException as e:
    print("Exception when calling DashboardPublicationControllerApi->updatePublicationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
dashId*
Long (int64)
Id of dashboard
Required
id*
Long (int64)
Id of publication to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


DataBlockController

countDatablockUsingEntite

count Datablock Using Entite


/service/datablocks/entites/{id}/usage

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/entites/{id}/usage?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            'Integer' result = apiInstance.countDatablockUsingEntite(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#countDatablockUsingEntite");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            'Integer' result = apiInstance.countDatablockUsingEntite(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#countDatablockUsingEntite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// count Datablock Using Entite
[apiInstance countDatablockUsingEntiteWith:id
    project:project
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.countDatablockUsingEntite(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class countDatablockUsingEntiteExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // count Datablock Using Entite
                'Integer' result = apiInstance.countDatablockUsingEntite(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.countDatablockUsingEntite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $result = $api_instance->countDatablockUsingEntite($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->countDatablockUsingEntite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->countDatablockUsingEntite(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->countDatablockUsingEntite: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # count Datablock Using Entite
    api_response = api_instance.count_datablock_using_entite(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->countDatablockUsingEntite: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDataBlockByUetId

create DataBlock By UetId


/service/datablock/create_by_uet

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablock/create_by_uet?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long body = ; // Long | uetId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createDataBlockByUetId(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#createDataBlockByUetId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long body = ; // Long | uetId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createDataBlockByUetId(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#createDataBlockByUetId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *body = ; // uetId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// create DataBlock By UetId
[apiInstance createDataBlockByUetIdWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{Long}} uetId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDataBlockByUetId(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDataBlockByUetIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new Long(); // Long | uetId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create DataBlock By UetId
                Long result = apiInstance.createDataBlockByUetId(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.createDataBlockByUetId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // Long | uetId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createDataBlockByUetId($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->createDataBlockByUetId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | uetId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createDataBlockByUetId(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->createDataBlockByUetId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # Long | uetId
project = 789 # Long | Project id (optional)

try: 
    # create DataBlock By UetId
    api_response = api_instance.create_data_block_by_uet_id(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->createDataBlockByUetId: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDataBlocksByUetIds

create DataBlocks By UetIds


/service/datablocks/create_by_uets

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/create_by_uets?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        array[Long] body = ; // array[Long] | uetIds
        Long project = 789; // Long | Project id
        try {
            array[Long] result = apiInstance.createDataBlocksByUetIds(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#createDataBlocksByUetIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        array[Long] body = ; // array[Long] | uetIds
        Long project = 789; // Long | Project id
        try {
            array[Long] result = apiInstance.createDataBlocksByUetIds(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#createDataBlocksByUetIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *body = ; // uetIds
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// create DataBlocks By UetIds
[apiInstance createDataBlocksByUetIdsWith:body
    project:project
              completionHandler: ^(array[Long] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{array[Long]}} uetIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDataBlocksByUetIds(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDataBlocksByUetIdsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new array[Long](); // array[Long] | uetIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create DataBlocks By UetIds
                array[Long] result = apiInstance.createDataBlocksByUetIds(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.createDataBlocksByUetIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // array[Long] | uetIds
$project = 789; // Long | Project id

try {
    $result = $api_instance->createDataBlocksByUetIds($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->createDataBlocksByUetIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[Long]->new()]; # array[Long] | uetIds
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createDataBlocksByUetIds(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->createDataBlocksByUetIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # array[Long] | uetIds
project = 789 # Long | Project id (optional)

try: 
    # create DataBlocks By UetIds
    api_response = api_instance.create_data_blocks_by_uet_ids(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->createDataBlocksByUetIds: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDatablock

create Datablock


/service/datablocks

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DataBlock body = ; // DataBlock | datablock
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createDatablock(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#createDatablock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DataBlock body = ; // DataBlock | datablock
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createDatablock(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#createDatablock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataBlock *body = ; // datablock
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// create Datablock
[apiInstance createDatablockWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{DataBlock}} datablock
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDatablock(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDatablockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new DataBlock(); // DataBlock | datablock
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Datablock
                Long result = apiInstance.createDatablock(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.createDatablock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // DataBlock | datablock
$project = 789; // Long | Project id

try {
    $result = $api_instance->createDatablock($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->createDatablock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataBlock->new(); # DataBlock | datablock
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createDatablock(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->createDatablock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # DataBlock | datablock
project = 789 # Long | Project id (optional)

try: 
    # create Datablock
    api_response = api_instance.create_datablock(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->createDatablock: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteBulkDataBlocks

delete Bulk DataBlocks


/service/datablocks

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/datablocks?datablockIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        array[Long] datablockIds = ; // array[Long] | datablockIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkDataBlocks(datablockIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#deleteBulkDataBlocks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        array[Long] datablockIds = ; // array[Long] | datablockIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteBulkDataBlocks(datablockIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#deleteBulkDataBlocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *datablockIds = ; // datablockIds
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// delete Bulk DataBlocks
[apiInstance deleteBulkDataBlocksWith:datablockIds
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockIds = ; // {{array[Long]}} datablockIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBulkDataBlocks(datablockIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBulkDataBlocksExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockIds = new array[Long](); // array[Long] | datablockIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Bulk DataBlocks
                apiInstance.deleteBulkDataBlocks(datablockIds, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.deleteBulkDataBlocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockIds = ; // array[Long] | datablockIds
$project = 789; // Long | Project id

try {
    $api_instance->deleteBulkDataBlocks($datablockIds, $project);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->deleteBulkDataBlocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockIds = []; # array[Long] | datablockIds
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteBulkDataBlocks(datablockIds => $datablockIds, project => $project);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->deleteBulkDataBlocks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockIds =  # array[Long] | datablockIds
project = 789 # Long | Project id (optional)

try: 
    # delete Bulk DataBlocks
    api_instance.delete_bulk_data_blocks(datablockIds, project=project)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->deleteBulkDataBlocks: %s\n" % e)

Parameters

Query parameters
Name Description
datablockIds*
array[Long] (int64)
datablockIds
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteDatablock

delete Datablock


/service/datablocks/{datablockId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/datablocks/{datablockId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDatablock(datablockId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#deleteDatablock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDatablock(datablockId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#deleteDatablock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// delete Datablock
[apiInstance deleteDatablockWith:datablockId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDatablock(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDatablockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Datablock
                apiInstance.deleteDatablock(datablockId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.deleteDatablock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $api_instance->deleteDatablock($datablockId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->deleteDatablock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDatablock(datablockId => $datablockId, project => $project);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->deleteDatablock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # delete Datablock
    api_instance.delete_datablock(datablockId, project=project)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->deleteDatablock: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDatablock

edit Datablock


/service/datablocks

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DataBlock body = ; // DataBlock | datablock
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.editDatablock(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#editDatablock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DataBlock body = ; // DataBlock | datablock
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.editDatablock(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#editDatablock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataBlock *body = ; // datablock
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// edit Datablock
[apiInstance editDatablockWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{DataBlock}} datablock
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editDatablock(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDatablockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new DataBlock(); // DataBlock | datablock
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Datablock
                Long result = apiInstance.editDatablock(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.editDatablock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // DataBlock | datablock
$project = 789; // Long | Project id

try {
    $result = $api_instance->editDatablock($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->editDatablock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataBlock->new(); # DataBlock | datablock
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editDatablock(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->editDatablock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # DataBlock | datablock
project = 789 # Long | Project id (optional)

try: 
    # edit Datablock
    api_response = api_instance.edit_datablock(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->editDatablock: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllDataBlocks

find All DataBlocks


/service/datablocks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Include public projects
        Long project = 789; // Long | Project id
        try {
            array[DataBlock] result = apiInstance.findAllDataBlocks(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findAllDataBlocks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Include public projects
        Long project = 789; // Long | Project id
        try {
            array[DataBlock] result = apiInstance.findAllDataBlocks(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findAllDataBlocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Include public projects (optional)
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// find All DataBlocks
[apiInstance findAllDataBlocksWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[DataBlock] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Include public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllDataBlocks(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllDataBlocksExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Include public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All DataBlocks
                array[DataBlock] result = apiInstance.findAllDataBlocks(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.findAllDataBlocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Include public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllDataBlocks($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->findAllDataBlocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Include public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllDataBlocks(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->findAllDataBlocks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Include public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # find All DataBlocks
    api_response = api_instance.find_all_data_blocks(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->findAllDataBlocks: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Include public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findDataBlockTopValues

find Top Values


/service/datablocks/top_values

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/top_values?column=&columnType=&ctx=&limit=&project=&searchMode=&sort=&text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DBBuilderGrammar body = ; // DBBuilderGrammar | dbGrammar
        String column = column_example; // String | column
        String columnType = columnType_example; // String | columnType
        Integer ctx = 56; // Integer | ctx
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String searchMode = searchMode_example; // String | searchMode
        String sort = sort_example; // String | sort
        String text = text_example; // String | text
        try {
            array['String'] result = apiInstance.findDataBlockTopValues(body, column, columnType, ctx, limit, project, searchMode, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDataBlockTopValues");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DBBuilderGrammar body = ; // DBBuilderGrammar | dbGrammar
        String column = column_example; // String | column
        String columnType = columnType_example; // String | columnType
        Integer ctx = 56; // Integer | ctx
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String searchMode = searchMode_example; // String | searchMode
        String sort = sort_example; // String | sort
        String text = text_example; // String | text
        try {
            array['String'] result = apiInstance.findDataBlockTopValues(body, column, columnType, ctx, limit, project, searchMode, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDataBlockTopValues");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DBBuilderGrammar *body = ; // dbGrammar
String *column = column_example; // column
String *columnType = columnType_example; // columnType
Integer *ctx = 56; // ctx
Integer *limit = 56; // limit (optional)
Long *project = 789; // Project id (optional)
String *searchMode = searchMode_example; // searchMode (optional)
String *sort = sort_example; // sort (optional)
String *text = text_example; // text (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// find Top Values
[apiInstance findDataBlockTopValuesWith:body
    column:column
    columnType:columnType
    ctx:ctx
    limit:limit
    project:project
    searchMode:searchMode
    sort:sort
    text:text
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{DBBuilderGrammar}} dbGrammar
var column = column_example; // {{String}} column
var columnType = columnType_example; // {{String}} columnType
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'limit': 56 // {{Integer}} limit
  'project': 789 // {{Long}} Project id
  'searchMode': searchMode_example // {{String}} searchMode
  'sort': sort_example // {{String}} sort
  'text': text_example // {{String}} text
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDataBlockTopValues(bodycolumncolumnTypectx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDataBlockTopValuesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new DBBuilderGrammar(); // DBBuilderGrammar | dbGrammar
            var column = column_example;  // String | column
            var columnType = columnType_example;  // String | columnType
            var ctx = 56;  // Integer | ctx
            var limit = 56;  // Integer | limit (optional) 
            var project = 789;  // Long | Project id (optional) 
            var searchMode = searchMode_example;  // String | searchMode (optional) 
            var sort = sort_example;  // String | sort (optional) 
            var text = text_example;  // String | text (optional) 

            try
            {
                // find Top Values
                array['String'] result = apiInstance.findDataBlockTopValues(body, column, columnType, ctx, limit, project, searchMode, sort, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.findDataBlockTopValues: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // DBBuilderGrammar | dbGrammar
$column = column_example; // String | column
$columnType = columnType_example; // String | columnType
$ctx = 56; // Integer | ctx
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$searchMode = searchMode_example; // String | searchMode
$sort = sort_example; // String | sort
$text = text_example; // String | text

try {
    $result = $api_instance->findDataBlockTopValues($body, $column, $columnType, $ctx, $limit, $project, $searchMode, $sort, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->findDataBlockTopValues: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = WWW::SwaggerClient::Object::DBBuilderGrammar->new(); # DBBuilderGrammar | dbGrammar
my $column = column_example; # String | column
my $columnType = columnType_example; # String | columnType
my $ctx = 56; # Integer | ctx
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $searchMode = searchMode_example; # String | searchMode
my $sort = sort_example; # String | sort
my $text = text_example; # String | text

eval { 
    my $result = $api_instance->findDataBlockTopValues(body => $body, column => $column, columnType => $columnType, ctx => $ctx, limit => $limit, project => $project, searchMode => $searchMode, sort => $sort, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->findDataBlockTopValues: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # DBBuilderGrammar | dbGrammar
column = column_example # String | column
columnType = columnType_example # String | columnType
ctx = 56 # Integer | ctx
limit = 56 # Integer | limit (optional)
project = 789 # Long | Project id (optional)
searchMode = searchMode_example # String | searchMode (optional)
sort = sort_example # String | sort (optional)
text = text_example # String | text (optional)

try: 
    # find Top Values
    api_response = api_instance.find_data_block_top_values(body, column, columnType, ctx, limit=limit, project=project, searchMode=searchMode, sort=sort, text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->findDataBlockTopValues: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
column*
String
column
Required
columnType*
String
columnType
Required
ctx*
Integer (int32)
ctx
Required
limit
Integer (int32)
limit
project
Long (int64)
Project id
searchMode
String
searchMode
sort
String
sort
text
String
text

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findDataBlockValues

find Distinct Values


/service/datablocks/distinct_values

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/distinct_values?column=&columnType=&ctx=&limit=&project=&sort=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DBBuilderGrammar body = ; // DBBuilderGrammar | dbGrammar
        String column = column_example; // String | column
        String columnType = columnType_example; // String | columnType
        Integer ctx = 56; // Integer | ctx
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String sort = sort_example; // String | sort
        Boolean useCache = true; // Boolean | useCache
        try {
            array['String'] result = apiInstance.findDataBlockValues(body, column, columnType, ctx, limit, project, sort, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDataBlockValues");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DBBuilderGrammar body = ; // DBBuilderGrammar | dbGrammar
        String column = column_example; // String | column
        String columnType = columnType_example; // String | columnType
        Integer ctx = 56; // Integer | ctx
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String sort = sort_example; // String | sort
        Boolean useCache = true; // Boolean | useCache
        try {
            array['String'] result = apiInstance.findDataBlockValues(body, column, columnType, ctx, limit, project, sort, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDataBlockValues");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DBBuilderGrammar *body = ; // dbGrammar
String *column = column_example; // column
String *columnType = columnType_example; // columnType
Integer *ctx = 56; // ctx
Integer *limit = 56; // limit (optional)
Long *project = 789; // Project id (optional)
String *sort = sort_example; // sort (optional)
Boolean *useCache = true; // useCache (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// find Distinct Values
[apiInstance findDataBlockValuesWith:body
    column:column
    columnType:columnType
    ctx:ctx
    limit:limit
    project:project
    sort:sort
    useCache:useCache
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{DBBuilderGrammar}} dbGrammar
var column = column_example; // {{String}} column
var columnType = columnType_example; // {{String}} columnType
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'limit': 56 // {{Integer}} limit
  'project': 789 // {{Long}} Project id
  'sort': sort_example // {{String}} sort
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDataBlockValues(bodycolumncolumnTypectx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDataBlockValuesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new DBBuilderGrammar(); // DBBuilderGrammar | dbGrammar
            var column = column_example;  // String | column
            var columnType = columnType_example;  // String | columnType
            var ctx = 56;  // Integer | ctx
            var limit = 56;  // Integer | limit (optional) 
            var project = 789;  // Long | Project id (optional) 
            var sort = sort_example;  // String | sort (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // find Distinct Values
                array['String'] result = apiInstance.findDataBlockValues(body, column, columnType, ctx, limit, project, sort, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.findDataBlockValues: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // DBBuilderGrammar | dbGrammar
$column = column_example; // String | column
$columnType = columnType_example; // String | columnType
$ctx = 56; // Integer | ctx
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$sort = sort_example; // String | sort
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->findDataBlockValues($body, $column, $columnType, $ctx, $limit, $project, $sort, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->findDataBlockValues: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = WWW::SwaggerClient::Object::DBBuilderGrammar->new(); # DBBuilderGrammar | dbGrammar
my $column = column_example; # String | column
my $columnType = columnType_example; # String | columnType
my $ctx = 56; # Integer | ctx
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $sort = sort_example; # String | sort
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->findDataBlockValues(body => $body, column => $column, columnType => $columnType, ctx => $ctx, limit => $limit, project => $project, sort => $sort, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->findDataBlockValues: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # DBBuilderGrammar | dbGrammar
column = column_example # String | column
columnType = columnType_example # String | columnType
ctx = 56 # Integer | ctx
limit = 56 # Integer | limit (optional)
project = 789 # Long | Project id (optional)
sort = sort_example # String | sort (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # find Distinct Values
    api_response = api_instance.find_data_block_values(body, column, columnType, ctx, limit=limit, project=project, sort=sort, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->findDataBlockValues: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
column*
String
column
Required
columnType*
String
columnType
Required
ctx*
Integer (int32)
ctx
Required
limit
Integer (int32)
limit
project
Long (int64)
Project id
sort
String
sort
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findDataBlocksByIds

find DataBlocks by ids


/service/datablocks_by_ids

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks_by_ids?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        array[Long] body = ; // array[Long] | ids
        Long project = 789; // Long | Project id
        try {
            array[DataBlock] result = apiInstance.findDataBlocksByIds(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDataBlocksByIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        array[Long] body = ; // array[Long] | ids
        Long project = 789; // Long | Project id
        try {
            array[DataBlock] result = apiInstance.findDataBlocksByIds(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDataBlocksByIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *body = ; // ids
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// find DataBlocks by ids
[apiInstance findDataBlocksByIdsWith:body
    project:project
              completionHandler: ^(array[DataBlock] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{array[Long]}} ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDataBlocksByIds(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDataBlocksByIdsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new array[Long](); // array[Long] | ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find DataBlocks by ids
                array[DataBlock] result = apiInstance.findDataBlocksByIds(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.findDataBlocksByIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // array[Long] | ids
$project = 789; // Long | Project id

try {
    $result = $api_instance->findDataBlocksByIds($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->findDataBlocksByIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[Long]->new()]; # array[Long] | ids
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findDataBlocksByIds(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->findDataBlocksByIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # array[Long] | ids
project = 789 # Long | Project id (optional)

try: 
    # find DataBlocks by ids
    api_response = api_instance.find_data_blocks_by_ids(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->findDataBlocksByIds: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findDatablockColumnUsage

find Datablock Column Usage


/service/datablocks/{id}/columns/{colId}/usage

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{id}/columns/{colId}/usage?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        String colId = colId_example; // String | colId
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            array[DcElement] result = apiInstance.findDatablockColumnUsage(colId, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDatablockColumnUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        String colId = colId_example; // String | colId
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            array[DcElement] result = apiInstance.findDatablockColumnUsage(colId, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDatablockColumnUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *colId = colId_example; // colId
Long *id = 789; // id
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// find Datablock Column Usage
[apiInstance findDatablockColumnUsageWith:colId
    id:id
    project:project
              completionHandler: ^(array[DcElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var colId = colId_example; // {{String}} colId
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDatablockColumnUsage(colId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDatablockColumnUsageExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var colId = colId_example;  // String | colId
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find Datablock Column Usage
                array[DcElement] result = apiInstance.findDatablockColumnUsage(colId, id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.findDatablockColumnUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$colId = colId_example; // String | colId
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $result = $api_instance->findDatablockColumnUsage($colId, $id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->findDatablockColumnUsage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $colId = colId_example; # String | colId
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findDatablockColumnUsage(colId => $colId, id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->findDatablockColumnUsage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
colId = colId_example # String | colId
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # find Datablock Column Usage
    api_response = api_instance.find_datablock_column_usage(colId, id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->findDatablockColumnUsage: %s\n" % e)

Parameters

Path parameters
Name Description
colId*
String
colId
Required
id*
Long (int64)
id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findDatablockUsage

find Datablock Usage


/service/datablocks/{id}/usage

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{id}/usage?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            array[DcElement] result = apiInstance.findDatablockUsage(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDatablockUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            array[DcElement] result = apiInstance.findDatablockUsage(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#findDatablockUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // id
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// find Datablock Usage
[apiInstance findDatablockUsageWith:id
    project:project
              completionHandler: ^(array[DcElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDatablockUsage(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDatablockUsageExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find Datablock Usage
                array[DcElement] result = apiInstance.findDatablockUsage(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.findDatablockUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $result = $api_instance->findDatablockUsage($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->findDatablockUsage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findDatablockUsage(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->findDatablockUsage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # find Datablock Usage
    api_response = api_instance.find_datablock_usage(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->findDatablockUsage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockById

get DataBlock By Id


/service/datablocks/{datablockId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataBlock result = apiInstance.getDataBlockById(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataBlock result = apiInstance.getDataBlockById(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get DataBlock By Id
[apiInstance getDataBlockByIdWith:datablockId
    project:project
              completionHandler: ^(DataBlock output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockById(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get DataBlock By Id
                DataBlock result = apiInstance.getDataBlockById(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getDataBlockById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockById($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getDataBlockById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockById(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getDataBlockById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # get DataBlock By Id
    api_response = api_instance.get_data_block_by_id(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getDataBlockById: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockColumnOrigin

get DataBlock Column Origin


/service/datablocks/column_origin/{datablockId}/{uuid}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/column_origin/{datablockId}/{uuid}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        String uuid = uuid_example; // String | uuid
        Long project = 789; // Long | Project id
        try {
            ColumnOrigin result = apiInstance.getDataBlockColumnOrigin(datablockId, uuid, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockColumnOrigin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        String uuid = uuid_example; // String | uuid
        Long project = 789; // Long | Project id
        try {
            ColumnOrigin result = apiInstance.getDataBlockColumnOrigin(datablockId, uuid, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockColumnOrigin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
String *uuid = uuid_example; // uuid
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get DataBlock Column Origin
[apiInstance getDataBlockColumnOriginWith:datablockId
    uuid:uuid
    project:project
              completionHandler: ^(ColumnOrigin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var uuid = uuid_example; // {{String}} uuid
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockColumnOrigin(datablockId, uuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockColumnOriginExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var uuid = uuid_example;  // String | uuid
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get DataBlock Column Origin
                ColumnOrigin result = apiInstance.getDataBlockColumnOrigin(datablockId, uuid, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getDataBlockColumnOrigin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$uuid = uuid_example; // String | uuid
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockColumnOrigin($datablockId, $uuid, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getDataBlockColumnOrigin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $uuid = uuid_example; # String | uuid
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockColumnOrigin(datablockId => $datablockId, uuid => $uuid, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getDataBlockColumnOrigin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
uuid = uuid_example # String | uuid
project = 789 # Long | Project id (optional)

try: 
    # get DataBlock Column Origin
    api_response = api_instance.get_data_block_column_origin(datablockId, uuid, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getDataBlockColumnOrigin: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
uuid*
String
uuid
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockColumns

get DataBlock Columns


/service/datablock/columns

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablock/columns?datablockId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[DBBuilderColumn] result = apiInstance.getDataBlockColumns(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockColumns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[DBBuilderColumn] result = apiInstance.getDataBlockColumns(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockColumns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get DataBlock Columns
[apiInstance getDataBlockColumnsWith:datablockId
    project:project
              completionHandler: ^(array[DBBuilderColumn] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockColumns(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockColumnsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get DataBlock Columns
                array[DBBuilderColumn] result = apiInstance.getDataBlockColumns(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getDataBlockColumns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockColumns($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getDataBlockColumns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockColumns(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getDataBlockColumns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # get DataBlock Columns
    api_response = api_instance.get_data_block_columns(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getDataBlockColumns: %s\n" % e)

Parameters

Query parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockColumnsCount

get DataBlock Columns Count


/service/datablock/{datablockId}/column_count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablock/{datablockId}/column_count?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getDataBlockColumnsCount(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockColumnsCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getDataBlockColumnsCount(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockColumnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get DataBlock Columns Count
[apiInstance getDataBlockColumnsCountWith:datablockId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockColumnsCount(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockColumnsCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get DataBlock Columns Count
                Long result = apiInstance.getDataBlockColumnsCount(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getDataBlockColumnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockColumnsCount($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getDataBlockColumnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockColumnsCount(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getDataBlockColumnsCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # get DataBlock Columns Count
    api_response = api_instance.get_data_block_columns_count(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getDataBlockColumnsCount: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockElementsForMove

Get datablock linked element for move/copy


/service/datablocks/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Datablock ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getDataBlockElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Datablock ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getDataBlockElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Datablock ID (optional)
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// Get datablock linked element for move/copy
[apiInstance getDataBlockElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Datablock ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Datablock ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get datablock linked element for move/copy
                array[DcUsedElement] result = apiInstance.getDataBlockElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getDataBlockElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Datablock ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getDataBlockElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Datablock ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getDataBlockElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Datablock ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get datablock linked element for move/copy
    api_response = api_instance.get_data_block_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getDataBlockElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Datablock ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockLinkedHdElements

get DataBlock linked Hd Elements


/service/datablocks/{datablockId}/hd_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/hd_elements?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[HdElement] result = apiInstance.getDataBlockLinkedHdElements(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockLinkedHdElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[HdElement] result = apiInstance.getDataBlockLinkedHdElements(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getDataBlockLinkedHdElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get DataBlock linked Hd Elements
[apiInstance getDataBlockLinkedHdElementsWith:datablockId
    project:project
              completionHandler: ^(array[HdElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockLinkedHdElements(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockLinkedHdElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get DataBlock linked Hd Elements
                array[HdElement] result = apiInstance.getDataBlockLinkedHdElements(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getDataBlockLinkedHdElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockLinkedHdElements($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getDataBlockLinkedHdElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockLinkedHdElements(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getDataBlockLinkedHdElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # get DataBlock linked Hd Elements
    api_response = api_instance.get_data_block_linked_hd_elements(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getDataBlockLinkedHdElements: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExposedDataBlocks

Get Exposed Datablocks


/service/exposed_datablocks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/exposed_datablocks?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[ExposedDataBlockDto] result = apiInstance.getExposedDataBlocks(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getExposedDataBlocks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[ExposedDataBlockDto] result = apiInstance.getExposedDataBlocks(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getExposedDataBlocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// Get Exposed Datablocks
[apiInstance getExposedDataBlocksWith:project
              completionHandler: ^(array[ExposedDataBlockDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExposedDataBlocks(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExposedDataBlocksExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get Exposed Datablocks
                array[ExposedDataBlockDto] result = apiInstance.getExposedDataBlocks(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getExposedDataBlocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExposedDataBlocks($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getExposedDataBlocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExposedDataBlocks(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getExposedDataBlocks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # Get Exposed Datablocks
    api_response = api_instance.get_exposed_data_blocks(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getExposedDataBlocks: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getLastPersistDate

get Last Persist Date


/service/datablocks/last_persist_date

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/last_persist_date?ctx=&datablockCode=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Integer ctx = 56; // Integer | ctx
        String datablockCode = datablockCode_example; // String | datablockCode
        Long project = 789; // Long | Project id
        try {
            'Date' result = apiInstance.getLastPersistDate(ctx, datablockCode, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getLastPersistDate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Integer ctx = 56; // Integer | ctx
        String datablockCode = datablockCode_example; // String | datablockCode
        Long project = 789; // Long | Project id
        try {
            'Date' result = apiInstance.getLastPersistDate(ctx, datablockCode, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getLastPersistDate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *datablockCode = datablockCode_example; // datablockCode
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get Last Persist Date
[apiInstance getLastPersistDateWith:ctx
    datablockCode:datablockCode
    project:project
              completionHandler: ^('Date' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var ctx = 56; // {{Integer}} ctx
var datablockCode = datablockCode_example; // {{String}} datablockCode
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLastPersistDate(ctx, datablockCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLastPersistDateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var ctx = 56;  // Integer | ctx
            var datablockCode = datablockCode_example;  // String | datablockCode
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Last Persist Date
                'Date' result = apiInstance.getLastPersistDate(ctx, datablockCode, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getLastPersistDate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$ctx = 56; // Integer | ctx
$datablockCode = datablockCode_example; // String | datablockCode
$project = 789; // Long | Project id

try {
    $result = $api_instance->getLastPersistDate($ctx, $datablockCode, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getLastPersistDate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $ctx = 56; # Integer | ctx
my $datablockCode = datablockCode_example; # String | datablockCode
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getLastPersistDate(ctx => $ctx, datablockCode => $datablockCode, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getLastPersistDate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
ctx = 56 # Integer | ctx
datablockCode = datablockCode_example # String | datablockCode
project = 789 # Long | Project id (optional)

try: 
    # get Last Persist Date
    api_response = api_instance.get_last_persist_date(ctx, datablockCode, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getLastPersistDate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
datablockCode*
String
datablockCode
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getReferencedDataBlocks

get Referenced DataBlocks


/service/datablock/referenced_datablocks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablock/referenced_datablocks?datablockId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[Long] result = apiInstance.getReferencedDataBlocks(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getReferencedDataBlocks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[Long] result = apiInstance.getReferencedDataBlocks(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getReferencedDataBlocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get Referenced DataBlocks
[apiInstance getReferencedDataBlocksWith:datablockId
    project:project
              completionHandler: ^(array[Long] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReferencedDataBlocks(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReferencedDataBlocksExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Referenced DataBlocks
                array[Long] result = apiInstance.getReferencedDataBlocks(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getReferencedDataBlocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getReferencedDataBlocks($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getReferencedDataBlocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getReferencedDataBlocks(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getReferencedDataBlocks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # get Referenced DataBlocks
    api_response = api_instance.get_referenced_data_blocks(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getReferencedDataBlocks: %s\n" % e)

Parameters

Query parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getUsedEntitesAndDataBlocks

get Used Entites And DataBlocks


/service/datablocks/{datablockId}/used_entites_and_datablocks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/used_entites_and_datablocks?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            ReferencedElements result = apiInstance.getUsedEntitesAndDataBlocks(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getUsedEntitesAndDataBlocks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            ReferencedElements result = apiInstance.getUsedEntitesAndDataBlocks(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getUsedEntitesAndDataBlocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get Used Entites And DataBlocks
[apiInstance getUsedEntitesAndDataBlocksWith:datablockId
    project:project
              completionHandler: ^(ReferencedElements output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsedEntitesAndDataBlocks(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsedEntitesAndDataBlocksExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Used Entites And DataBlocks
                ReferencedElements result = apiInstance.getUsedEntitesAndDataBlocks(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getUsedEntitesAndDataBlocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getUsedEntitesAndDataBlocks($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getUsedEntitesAndDataBlocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getUsedEntitesAndDataBlocks(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getUsedEntitesAndDataBlocks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # get Used Entites And DataBlocks
    api_response = api_instance.get_used_entites_and_data_blocks(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getUsedEntitesAndDataBlocks: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getUsedEntitesAndDataBlocksCount

get Count of Used Entites And DataBlocks


/service/datablocks/{datablockId}/referencedElementsIds/{referencedElementsIds}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/referencedElementsIds/{referencedElementsIds}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        String referencedElementsIds = referencedElementsIds_example; // String | referencedElementsIds
        Long project = 789; // Long | Project id
        try {
            ReferencedElements result = apiInstance.getUsedEntitesAndDataBlocksCount(datablockId, referencedElementsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getUsedEntitesAndDataBlocksCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        String referencedElementsIds = referencedElementsIds_example; // String | referencedElementsIds
        Long project = 789; // Long | Project id
        try {
            ReferencedElements result = apiInstance.getUsedEntitesAndDataBlocksCount(datablockId, referencedElementsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#getUsedEntitesAndDataBlocksCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
String *referencedElementsIds = referencedElementsIds_example; // referencedElementsIds
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// get Count of Used Entites And DataBlocks
[apiInstance getUsedEntitesAndDataBlocksCountWith:datablockId
    referencedElementsIds:referencedElementsIds
    project:project
              completionHandler: ^(ReferencedElements output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var referencedElementsIds = referencedElementsIds_example; // {{String}} referencedElementsIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsedEntitesAndDataBlocksCount(datablockId, referencedElementsIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsedEntitesAndDataBlocksCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var referencedElementsIds = referencedElementsIds_example;  // String | referencedElementsIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Count of Used Entites And DataBlocks
                ReferencedElements result = apiInstance.getUsedEntitesAndDataBlocksCount(datablockId, referencedElementsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.getUsedEntitesAndDataBlocksCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$referencedElementsIds = referencedElementsIds_example; // String | referencedElementsIds
$project = 789; // Long | Project id

try {
    $result = $api_instance->getUsedEntitesAndDataBlocksCount($datablockId, $referencedElementsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->getUsedEntitesAndDataBlocksCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $referencedElementsIds = referencedElementsIds_example; # String | referencedElementsIds
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getUsedEntitesAndDataBlocksCount(datablockId => $datablockId, referencedElementsIds => $referencedElementsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->getUsedEntitesAndDataBlocksCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
referencedElementsIds = referencedElementsIds_example # String | referencedElementsIds
project = 789 # Long | Project id (optional)

try: 
    # get Count of Used Entites And DataBlocks
    api_response = api_instance.get_used_entites_and_data_blocks_count(datablockId, referencedElementsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->getUsedEntitesAndDataBlocksCount: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
referencedElementsIds*
String
referencedElementsIds
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


isChangedUsingPUT

isChanged


/service/datablocks/is_changed

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/is_changed?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DataBlock body = ; // DataBlock | datablock
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.isChangedUsingPUT(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#isChangedUsingPUT");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        DataBlock body = ; // DataBlock | datablock
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.isChangedUsingPUT(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#isChangedUsingPUT");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataBlock *body = ; // datablock
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// isChanged
[apiInstance isChangedUsingPUTWith:body
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var body = ; // {{DataBlock}} datablock
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isChangedUsingPUT(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isChangedUsingPUTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var body = new DataBlock(); // DataBlock | datablock
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // isChanged
                'Boolean' result = apiInstance.isChangedUsingPUT(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.isChangedUsingPUT: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$body = ; // DataBlock | datablock
$project = 789; // Long | Project id

try {
    $result = $api_instance->isChangedUsingPUT($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->isChangedUsingPUT: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataBlock->new(); # DataBlock | datablock
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->isChangedUsingPUT(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->isChangedUsingPUT: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
body =  # DataBlock | datablock
project = 789 # Long | Project id (optional)

try: 
    # isChanged
    api_response = api_instance.is_changed_using_put(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->isChangedUsingPUT: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


isDataBlock

isDataBlock


/service/datablocks/is_datablock

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/is_datablock?datablockId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.isDataBlock(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#isDataBlock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.isDataBlock(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#isDataBlock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// isDataBlock
[apiInstance isDataBlockWith:datablockId
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isDataBlock(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isDataBlockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // isDataBlock
                'Boolean' result = apiInstance.isDataBlock(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.isDataBlock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->isDataBlock($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->isDataBlock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->isDataBlock(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->isDataBlock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # isDataBlock
    api_response = api_instance.is_data_block(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->isDataBlock: %s\n" % e)

Parameters

Query parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later



moveDataBlockElements

Move Datablock and linked elements to another project


/service/datablocks/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Datablock ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveDataBlockElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#moveDataBlockElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockControllerApi;

public class DataBlockControllerApiExample {

    public static void main(String[] args) {
        DataBlockControllerApi apiInstance = new DataBlockControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Datablock ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveDataBlockElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockControllerApi#moveDataBlockElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Datablock ID (optional)
Long *project = 789; // Project id (optional)

DataBlockControllerApi *apiInstance = [[DataBlockControllerApi alloc] init];

// Move Datablock and linked elements to another project
[apiInstance moveDataBlockElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Datablock ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveDataBlockElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveDataBlockElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Datablock ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move Datablock and linked elements to another project
                DcMoveResponse result = apiInstance.moveDataBlockElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockControllerApi.moveDataBlockElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Datablock ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveDataBlockElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockControllerApi->moveDataBlockElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Datablock ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveDataBlockElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockControllerApi->moveDataBlockElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Datablock ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move Datablock and linked elements to another project
    api_response = api_instance.move_data_block_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockControllerApi->moveDataBlockElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Datablock ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DataBlockExecController

execDataBlockAndGetJobKey

exec DataBlock And Get JobKey


/service/datablock/exec

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablock/exec?clientId=&ctx=&elementId=&parentId=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockExecControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockExecControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockExecControllerApi apiInstance = new DataBlockExecControllerApi();
        DBBuilderGrammar body = ; // DBBuilderGrammar | grammar
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        Long elementId = 789; // Long | elementId
        Long parentId = 789; // Long | parentId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execDataBlockAndGetJobKey(body, clientId, ctx, elementId, parentId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExecControllerApi#execDataBlockAndGetJobKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockExecControllerApi;

public class DataBlockExecControllerApiExample {

    public static void main(String[] args) {
        DataBlockExecControllerApi apiInstance = new DataBlockExecControllerApi();
        DBBuilderGrammar body = ; // DBBuilderGrammar | grammar
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        Long elementId = 789; // Long | elementId
        Long parentId = 789; // Long | parentId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execDataBlockAndGetJobKey(body, clientId, ctx, elementId, parentId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExecControllerApi#execDataBlockAndGetJobKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DBBuilderGrammar *body = ; // grammar
String *clientId = clientId_example; // clientId (optional)
Integer *ctx = 56; // ctx (optional)
Long *elementId = 789; // elementId (optional)
Long *parentId = 789; // parentId (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

DataBlockExecControllerApi *apiInstance = [[DataBlockExecControllerApi alloc] init];

// exec DataBlock And Get JobKey
[apiInstance execDataBlockAndGetJobKeyWith:body
    clientId:clientId
    ctx:ctx
    elementId:elementId
    parentId:parentId
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockExecControllerApi()
var body = ; // {{DBBuilderGrammar}} grammar
var opts = { 
  'clientId': clientId_example // {{String}} clientId
  'ctx': 56 // {{Integer}} ctx
  'elementId': 789 // {{Long}} elementId
  'parentId': 789 // {{Long}} parentId
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.execDataBlockAndGetJobKey(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class execDataBlockAndGetJobKeyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockExecControllerApi();
            var body = new DBBuilderGrammar(); // DBBuilderGrammar | grammar
            var clientId = clientId_example;  // String | clientId (optional) 
            var ctx = 56;  // Integer | ctx (optional) 
            var elementId = 789;  // Long | elementId (optional) 
            var parentId = 789;  // Long | parentId (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // exec DataBlock And Get JobKey
                JobKeyResponse result = apiInstance.execDataBlockAndGetJobKey(body, clientId, ctx, elementId, parentId, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockExecControllerApi.execDataBlockAndGetJobKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockExecControllerApi();
$body = ; // DBBuilderGrammar | grammar
$clientId = clientId_example; // String | clientId
$ctx = 56; // Integer | ctx
$elementId = 789; // Long | elementId
$parentId = 789; // Long | parentId
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->execDataBlockAndGetJobKey($body, $clientId, $ctx, $elementId, $parentId, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockExecControllerApi->execDataBlockAndGetJobKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockExecControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockExecControllerApi->new();
my $body = WWW::SwaggerClient::Object::DBBuilderGrammar->new(); # DBBuilderGrammar | grammar
my $clientId = clientId_example; # String | clientId
my $ctx = 56; # Integer | ctx
my $elementId = 789; # Long | elementId
my $parentId = 789; # Long | parentId
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->execDataBlockAndGetJobKey(body => $body, clientId => $clientId, ctx => $ctx, elementId => $elementId, parentId => $parentId, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockExecControllerApi->execDataBlockAndGetJobKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockExecControllerApi()
body =  # DBBuilderGrammar | grammar
clientId = clientId_example # String | clientId (optional)
ctx = 56 # Integer | ctx (optional)
elementId = 789 # Long | elementId (optional)
parentId = 789 # Long | parentId (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # exec DataBlock And Get JobKey
    api_response = api_instance.exec_data_block_and_get_job_key(body, clientId=clientId, ctx=ctx, elementId=elementId, parentId=parentId, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockExecControllerApi->execDataBlockAndGetJobKey: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
clientId
String
clientId
ctx
Integer (int32)
ctx
elementId
Long (int64)
elementId
parentId
Long (int64)
parentId
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataByJobKey

get Data By JobKey


/service/datablock/exec/result

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablock/exec/result?ctx=&jobKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockExecControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockExecControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockExecControllerApi apiInstance = new DataBlockExecControllerApi();
        String jobKey = jobKey_example; // String | jobKey
        Integer ctx = 56; // Integer | ctx
        try {
            ExecDataResult result = apiInstance.getDataByJobKey(jobKey, ctx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExecControllerApi#getDataByJobKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockExecControllerApi;

public class DataBlockExecControllerApiExample {

    public static void main(String[] args) {
        DataBlockExecControllerApi apiInstance = new DataBlockExecControllerApi();
        String jobKey = jobKey_example; // String | jobKey
        Integer ctx = 56; // Integer | ctx
        try {
            ExecDataResult result = apiInstance.getDataByJobKey(jobKey, ctx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExecControllerApi#getDataByJobKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *jobKey = jobKey_example; // jobKey
Integer *ctx = 56; // ctx (optional)

DataBlockExecControllerApi *apiInstance = [[DataBlockExecControllerApi alloc] init];

// get Data By JobKey
[apiInstance getDataByJobKeyWith:jobKey
    ctx:ctx
              completionHandler: ^(ExecDataResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockExecControllerApi()
var jobKey = jobKey_example; // {{String}} jobKey
var opts = { 
  'ctx': 56 // {{Integer}} ctx
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataByJobKey(jobKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataByJobKeyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockExecControllerApi();
            var jobKey = jobKey_example;  // String | jobKey
            var ctx = 56;  // Integer | ctx (optional) 

            try
            {
                // get Data By JobKey
                ExecDataResult result = apiInstance.getDataByJobKey(jobKey, ctx);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockExecControllerApi.getDataByJobKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockExecControllerApi();
$jobKey = jobKey_example; // String | jobKey
$ctx = 56; // Integer | ctx

try {
    $result = $api_instance->getDataByJobKey($jobKey, $ctx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockExecControllerApi->getDataByJobKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockExecControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockExecControllerApi->new();
my $jobKey = jobKey_example; # String | jobKey
my $ctx = 56; # Integer | ctx

eval { 
    my $result = $api_instance->getDataByJobKey(jobKey => $jobKey, ctx => $ctx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockExecControllerApi->getDataByJobKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockExecControllerApi()
jobKey = jobKey_example # String | jobKey
ctx = 56 # Integer | ctx (optional)

try: 
    # get Data By JobKey
    api_response = api_instance.get_data_by_job_key(jobKey, ctx=ctx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockExecControllerApi->getDataByJobKey: %s\n" % e)

Parameters

Query parameters
Name Description
ctx
Integer (int32)
ctx
jobKey*
String
jobKey
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DataBlockExportHistoryController

findAllExportHistory

Find all export history


/service/datablocks/export_history

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/export_history?project=&skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        LoadOptions body = ; // LoadOptions | loadingOptions
        Long project = 789; // Long | Project id
        Integer skip = 56; // Integer | skip
        Integer take = 56; // Integer | take
        try {
            array[DataBlockExportHistoryDTO] result = apiInstance.findAllExportHistory(body, project, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findAllExportHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        LoadOptions body = ; // LoadOptions | loadingOptions
        Long project = 789; // Long | Project id
        Integer skip = 56; // Integer | skip
        Integer take = 56; // Integer | take
        try {
            array[DataBlockExportHistoryDTO] result = apiInstance.findAllExportHistory(body, project, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findAllExportHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
LoadOptions *body = ; // loadingOptions
Long *project = 789; // Project id (optional)
Integer *skip = 56; // skip (optional)
Integer *take = 56; // take (optional)

DataBlockExportHistoryControllerApi *apiInstance = [[DataBlockExportHistoryControllerApi alloc] init];

// Find all export history
[apiInstance findAllExportHistoryWith:body
    project:project
    skip:skip
    take:take
              completionHandler: ^(array[DataBlockExportHistoryDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockExportHistoryControllerApi()
var body = ; // {{LoadOptions}} loadingOptions
var opts = { 
  'project': 789 // {{Long}} Project id
  'skip': 56 // {{Integer}} skip
  'take': 56 // {{Integer}} take
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllExportHistory(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllExportHistoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockExportHistoryControllerApi();
            var body = new LoadOptions(); // LoadOptions | loadingOptions
            var project = 789;  // Long | Project id (optional) 
            var skip = 56;  // Integer | skip (optional) 
            var take = 56;  // Integer | take (optional) 

            try
            {
                // Find all export history
                array[DataBlockExportHistoryDTO] result = apiInstance.findAllExportHistory(body, project, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockExportHistoryControllerApi.findAllExportHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockExportHistoryControllerApi();
$body = ; // LoadOptions | loadingOptions
$project = 789; // Long | Project id
$skip = 56; // Integer | skip
$take = 56; // Integer | take

try {
    $result = $api_instance->findAllExportHistory($body, $project, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockExportHistoryControllerApi->findAllExportHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockExportHistoryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockExportHistoryControllerApi->new();
my $body = WWW::SwaggerClient::Object::LoadOptions->new(); # LoadOptions | loadingOptions
my $project = 789; # Long | Project id
my $skip = 56; # Integer | skip
my $take = 56; # Integer | take

eval { 
    my $result = $api_instance->findAllExportHistory(body => $body, project => $project, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockExportHistoryControllerApi->findAllExportHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockExportHistoryControllerApi()
body =  # LoadOptions | loadingOptions
project = 789 # Long | Project id (optional)
skip = 56 # Integer | skip (optional)
take = 56 # Integer | take (optional)

try: 
    # Find all export history
    api_response = api_instance.find_all_export_history(body, project=project, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockExportHistoryControllerApi->findAllExportHistory: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id
skip
Integer (int32)
skip
take
Integer (int32)
take

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findExportHistoryByHistoryId

Find export job status by export history id


/service/datablocks/export_history/{exportHistoryId}/status

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/export_history/{exportHistoryId}/status?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        Long exportHistoryId = 789; // Long | exportHistoryId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.findExportHistoryByHistoryId(exportHistoryId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findExportHistoryByHistoryId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        Long exportHistoryId = 789; // Long | exportHistoryId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.findExportHistoryByHistoryId(exportHistoryId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findExportHistoryByHistoryId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *exportHistoryId = 789; // exportHistoryId
Long *project = 789; // Project id (optional)

DataBlockExportHistoryControllerApi *apiInstance = [[DataBlockExportHistoryControllerApi alloc] init];

// Find export job status by export history id
[apiInstance findExportHistoryByHistoryIdWith:exportHistoryId
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockExportHistoryControllerApi()
var exportHistoryId = 789; // {{Long}} exportHistoryId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findExportHistoryByHistoryId(exportHistoryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findExportHistoryByHistoryIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockExportHistoryControllerApi();
            var exportHistoryId = 789;  // Long | exportHistoryId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Find export job status by export history id
                'String' result = apiInstance.findExportHistoryByHistoryId(exportHistoryId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockExportHistoryControllerApi.findExportHistoryByHistoryId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockExportHistoryControllerApi();
$exportHistoryId = 789; // Long | exportHistoryId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findExportHistoryByHistoryId($exportHistoryId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockExportHistoryControllerApi->findExportHistoryByHistoryId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockExportHistoryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockExportHistoryControllerApi->new();
my $exportHistoryId = 789; # Long | exportHistoryId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findExportHistoryByHistoryId(exportHistoryId => $exportHistoryId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockExportHistoryControllerApi->findExportHistoryByHistoryId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockExportHistoryControllerApi()
exportHistoryId = 789 # Long | exportHistoryId
project = 789 # Long | Project id (optional)

try: 
    # Find export job status by export history id
    api_response = api_instance.find_export_history_by_history_id(exportHistoryId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockExportHistoryControllerApi->findExportHistoryByHistoryId: %s\n" % e)

Parameters

Path parameters
Name Description
exportHistoryId*
Long (int64)
exportHistoryId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findExportHistoryById

Find export history by id


/service/datablocks/export_history/{exportHistoryId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/export_history/{exportHistoryId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        Long exportHistoryId = 789; // Long | exportHistoryId
        Long project = 789; // Long | Project id
        try {
            DataBlockExportHistoryDTO result = apiInstance.findExportHistoryById(exportHistoryId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findExportHistoryById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        Long exportHistoryId = 789; // Long | exportHistoryId
        Long project = 789; // Long | Project id
        try {
            DataBlockExportHistoryDTO result = apiInstance.findExportHistoryById(exportHistoryId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findExportHistoryById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *exportHistoryId = 789; // exportHistoryId
Long *project = 789; // Project id (optional)

DataBlockExportHistoryControllerApi *apiInstance = [[DataBlockExportHistoryControllerApi alloc] init];

// Find export history by id
[apiInstance findExportHistoryByIdWith:exportHistoryId
    project:project
              completionHandler: ^(DataBlockExportHistoryDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockExportHistoryControllerApi()
var exportHistoryId = 789; // {{Long}} exportHistoryId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findExportHistoryById(exportHistoryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findExportHistoryByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockExportHistoryControllerApi();
            var exportHistoryId = 789;  // Long | exportHistoryId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Find export history by id
                DataBlockExportHistoryDTO result = apiInstance.findExportHistoryById(exportHistoryId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockExportHistoryControllerApi.findExportHistoryById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockExportHistoryControllerApi();
$exportHistoryId = 789; // Long | exportHistoryId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findExportHistoryById($exportHistoryId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockExportHistoryControllerApi->findExportHistoryById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockExportHistoryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockExportHistoryControllerApi->new();
my $exportHistoryId = 789; # Long | exportHistoryId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findExportHistoryById(exportHistoryId => $exportHistoryId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockExportHistoryControllerApi->findExportHistoryById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockExportHistoryControllerApi()
exportHistoryId = 789 # Long | exportHistoryId
project = 789 # Long | Project id (optional)

try: 
    # Find export history by id
    api_response = api_instance.find_export_history_by_id(exportHistoryId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockExportHistoryControllerApi->findExportHistoryById: %s\n" % e)

Parameters

Path parameters
Name Description
exportHistoryId*
Long (int64)
exportHistoryId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findExportRequestByHistoryById

Find export history by id


/service/v8/datablocks/export_history/{exportHistoryId}/request

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/export_history/{exportHistoryId}/request?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

import java.io.File;
import java.util.*;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        Long exportHistoryId = 789; // Long | exportHistoryId
        Long project = 789; // Long | Project id
        try {
            DataSparkExportRequest result = apiInstance.findExportRequestByHistoryById(exportHistoryId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findExportRequestByHistoryById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataBlockExportHistoryControllerApi;

public class DataBlockExportHistoryControllerApiExample {

    public static void main(String[] args) {
        DataBlockExportHistoryControllerApi apiInstance = new DataBlockExportHistoryControllerApi();
        Long exportHistoryId = 789; // Long | exportHistoryId
        Long project = 789; // Long | Project id
        try {
            DataSparkExportRequest result = apiInstance.findExportRequestByHistoryById(exportHistoryId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataBlockExportHistoryControllerApi#findExportRequestByHistoryById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *exportHistoryId = 789; // exportHistoryId
Long *project = 789; // Project id (optional)

DataBlockExportHistoryControllerApi *apiInstance = [[DataBlockExportHistoryControllerApi alloc] init];

// Find export history by id
[apiInstance findExportRequestByHistoryByIdWith:exportHistoryId
    project:project
              completionHandler: ^(DataSparkExportRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataBlockExportHistoryControllerApi()
var exportHistoryId = 789; // {{Long}} exportHistoryId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findExportRequestByHistoryById(exportHistoryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findExportRequestByHistoryByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataBlockExportHistoryControllerApi();
            var exportHistoryId = 789;  // Long | exportHistoryId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Find export history by id
                DataSparkExportRequest result = apiInstance.findExportRequestByHistoryById(exportHistoryId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataBlockExportHistoryControllerApi.findExportRequestByHistoryById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataBlockExportHistoryControllerApi();
$exportHistoryId = 789; // Long | exportHistoryId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findExportRequestByHistoryById($exportHistoryId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataBlockExportHistoryControllerApi->findExportRequestByHistoryById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataBlockExportHistoryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataBlockExportHistoryControllerApi->new();
my $exportHistoryId = 789; # Long | exportHistoryId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findExportRequestByHistoryById(exportHistoryId => $exportHistoryId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataBlockExportHistoryControllerApi->findExportRequestByHistoryById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataBlockExportHistoryControllerApi()
exportHistoryId = 789 # Long | exportHistoryId
project = 789 # Long | Project id (optional)

try: 
    # Find export history by id
    api_response = api_instance.find_export_request_by_history_by_id(exportHistoryId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataBlockExportHistoryControllerApi->findExportRequestByHistoryById: %s\n" % e)

Parameters

Path parameters
Name Description
exportHistoryId*
Long (int64)
exportHistoryId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DataCatalogController

findElementById

Get Data Catalog element details


/service/data_catalogue/{elementId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/data_catalogue/{elementId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataCatalogControllerApi;

import java.io.File;
import java.util.*;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        Long elementId = 789; // Long | elementId
        try {
            DataCatalogItemDetails result = apiInstance.findElementById(elementId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#findElementById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataCatalogControllerApi;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        Long elementId = 789; // Long | elementId
        try {
            DataCatalogItemDetails result = apiInstance.findElementById(elementId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#findElementById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *elementId = 789; // elementId

DataCatalogControllerApi *apiInstance = [[DataCatalogControllerApi alloc] init];

// Get Data Catalog element details
[apiInstance findElementByIdWith:elementId
              completionHandler: ^(DataCatalogItemDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataCatalogControllerApi()
var elementId = 789; // {{Long}} elementId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findElementById(elementId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findElementByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataCatalogControllerApi();
            var elementId = 789;  // Long | elementId

            try
            {
                // Get Data Catalog element details
                DataCatalogItemDetails result = apiInstance.findElementById(elementId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataCatalogControllerApi.findElementById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataCatalogControllerApi();
$elementId = 789; // Long | elementId

try {
    $result = $api_instance->findElementById($elementId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataCatalogControllerApi->findElementById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataCatalogControllerApi->new();
my $elementId = 789; # Long | elementId

eval { 
    my $result = $api_instance->findElementById(elementId => $elementId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataCatalogControllerApi->findElementById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataCatalogControllerApi()
elementId = 789 # Long | elementId

try: 
    # Get Data Catalog element details
    api_response = api_instance.find_element_by_id(elementId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataCatalogControllerApi->findElementById: %s\n" % e)

Parameters

Path parameters
Name Description
elementId*
Long (int64)
elementId
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findElementsByKeywords

List Data Catalog elements


/service/data_catalogue

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/data_catalogue"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataCatalogControllerApi;

import java.io.File;
import java.util.*;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        DataCatalogRequest body = ; // DataCatalogRequest | dataCatalogRequest
        try {
            array[DataCatalogItem] result = apiInstance.findElementsByKeywords(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#findElementsByKeywords");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataCatalogControllerApi;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        DataCatalogRequest body = ; // DataCatalogRequest | dataCatalogRequest
        try {
            array[DataCatalogItem] result = apiInstance.findElementsByKeywords(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#findElementsByKeywords");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataCatalogRequest *body = ; // dataCatalogRequest

DataCatalogControllerApi *apiInstance = [[DataCatalogControllerApi alloc] init];

// List Data Catalog elements
[apiInstance findElementsByKeywordsWith:body
              completionHandler: ^(array[DataCatalogItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataCatalogControllerApi()
var body = ; // {{DataCatalogRequest}} dataCatalogRequest

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findElementsByKeywords(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findElementsByKeywordsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataCatalogControllerApi();
            var body = new DataCatalogRequest(); // DataCatalogRequest | dataCatalogRequest

            try
            {
                // List Data Catalog elements
                array[DataCatalogItem] result = apiInstance.findElementsByKeywords(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataCatalogControllerApi.findElementsByKeywords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataCatalogControllerApi();
$body = ; // DataCatalogRequest | dataCatalogRequest

try {
    $result = $api_instance->findElementsByKeywords($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataCatalogControllerApi->findElementsByKeywords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataCatalogControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataCatalogRequest->new(); # DataCatalogRequest | dataCatalogRequest

eval { 
    my $result = $api_instance->findElementsByKeywords(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataCatalogControllerApi->findElementsByKeywords: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataCatalogControllerApi()
body =  # DataCatalogRequest | dataCatalogRequest

try: 
    # List Data Catalog elements
    api_response = api_instance.find_elements_by_keywords(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataCatalogControllerApi->findElementsByKeywords: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getElementColumnsAndRowsNumber

getElementColumnsAndRowsNumber


/service/data_catalogue/{elementId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/data_catalogue/{elementId}/count?ctx="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataCatalogControllerApi;

import java.io.File;
import java.util.*;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long elementId = 789; // Long | elementId
        try {
            DataCatalogItemCount result = apiInstance.getElementColumnsAndRowsNumber(ctx, elementId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#getElementColumnsAndRowsNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataCatalogControllerApi;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long elementId = 789; // Long | elementId
        try {
            DataCatalogItemCount result = apiInstance.getElementColumnsAndRowsNumber(ctx, elementId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#getElementColumnsAndRowsNumber");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *elementId = 789; // elementId

DataCatalogControllerApi *apiInstance = [[DataCatalogControllerApi alloc] init];

// getElementColumnsAndRowsNumber
[apiInstance getElementColumnsAndRowsNumberWith:ctx
    elementId:elementId
              completionHandler: ^(DataCatalogItemCount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataCatalogControllerApi()
var ctx = 56; // {{Integer}} ctx
var elementId = 789; // {{Long}} elementId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getElementColumnsAndRowsNumber(ctx, elementId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getElementColumnsAndRowsNumberExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataCatalogControllerApi();
            var ctx = 56;  // Integer | ctx
            var elementId = 789;  // Long | elementId

            try
            {
                // getElementColumnsAndRowsNumber
                DataCatalogItemCount result = apiInstance.getElementColumnsAndRowsNumber(ctx, elementId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataCatalogControllerApi.getElementColumnsAndRowsNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataCatalogControllerApi();
$ctx = 56; // Integer | ctx
$elementId = 789; // Long | elementId

try {
    $result = $api_instance->getElementColumnsAndRowsNumber($ctx, $elementId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataCatalogControllerApi->getElementColumnsAndRowsNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataCatalogControllerApi->new();
my $ctx = 56; # Integer | ctx
my $elementId = 789; # Long | elementId

eval { 
    my $result = $api_instance->getElementColumnsAndRowsNumber(ctx => $ctx, elementId => $elementId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataCatalogControllerApi->getElementColumnsAndRowsNumber: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataCatalogControllerApi()
ctx = 56 # Integer | ctx
elementId = 789 # Long | elementId

try: 
    # getElementColumnsAndRowsNumber
    api_response = api_instance.get_element_columns_and_rows_number(ctx, elementId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataCatalogControllerApi->getElementColumnsAndRowsNumber: %s\n" % e)

Parameters

Path parameters
Name Description
elementId*
Long (int64)
elementId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


sendMessageToElementAdmins

Send message to element project admins


/service/data_catalogue/{elementId}/message

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/data_catalogue/{elementId}/message?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataCatalogControllerApi;

import java.io.File;
import java.util.*;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        BasicMessage body = ; // BasicMessage | basicMessage
        Long elementId = 789; // Long | elementId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.sendMessageToElementAdmins(body, elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#sendMessageToElementAdmins");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataCatalogControllerApi;

public class DataCatalogControllerApiExample {

    public static void main(String[] args) {
        DataCatalogControllerApi apiInstance = new DataCatalogControllerApi();
        BasicMessage body = ; // BasicMessage | basicMessage
        Long elementId = 789; // Long | elementId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.sendMessageToElementAdmins(body, elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCatalogControllerApi#sendMessageToElementAdmins");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
BasicMessage *body = ; // basicMessage
Long *elementId = 789; // elementId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DataCatalogControllerApi *apiInstance = [[DataCatalogControllerApi alloc] init];

// Send message to element project admins
[apiInstance sendMessageToElementAdminsWith:body
    elementId:elementId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataCatalogControllerApi()
var body = ; // {{BasicMessage}} basicMessage
var elementId = 789; // {{Long}} elementId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendMessageToElementAdmins(bodyelementId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sendMessageToElementAdminsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataCatalogControllerApi();
            var body = new BasicMessage(); // BasicMessage | basicMessage
            var elementId = 789;  // Long | elementId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Send message to element project admins
                apiInstance.sendMessageToElementAdmins(body, elementId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataCatalogControllerApi.sendMessageToElementAdmins: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataCatalogControllerApi();
$body = ; // BasicMessage | basicMessage
$elementId = 789; // Long | elementId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->sendMessageToElementAdmins($body, $elementId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling DataCatalogControllerApi->sendMessageToElementAdmins: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataCatalogControllerApi->new();
my $body = WWW::SwaggerClient::Object::BasicMessage->new(); # BasicMessage | basicMessage
my $elementId = 789; # Long | elementId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->sendMessageToElementAdmins(body => $body, elementId => $elementId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling DataCatalogControllerApi->sendMessageToElementAdmins: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataCatalogControllerApi()
body =  # BasicMessage | basicMessage
elementId = 789 # Long | elementId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Send message to element project admins
    api_instance.send_message_to_element_admins(body, elementId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling DataCatalogControllerApi->sendMessageToElementAdmins: %s\n" % e)

Parameters

Path parameters
Name Description
elementId*
Long (int64)
elementId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DataExposeController

addPermissionFilter

Add Datablock Expose Permission filter


/service/datablocks/{datablockId}/expose/params/filters

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/expose/params/filters?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        DataExposePermissionFilter body = ; // DataExposePermissionFilter | filter
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExposePermissionFilter result = apiInstance.addPermissionFilter(body, datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#addPermissionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        DataExposePermissionFilter body = ; // DataExposePermissionFilter | filter
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExposePermissionFilter result = apiInstance.addPermissionFilter(body, datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#addPermissionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataExposePermissionFilter *body = ; // filter
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Add Datablock Expose Permission filter
[apiInstance addPermissionFilterWith:body
    datablockId:datablockId
    project:project
              completionHandler: ^(DataExposePermissionFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var body = ; // {{DataExposePermissionFilter}} filter
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPermissionFilter(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addPermissionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var body = new DataExposePermissionFilter(); // DataExposePermissionFilter | filter
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Add Datablock Expose Permission filter
                DataExposePermissionFilter result = apiInstance.addPermissionFilter(body, datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.addPermissionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$body = ; // DataExposePermissionFilter | filter
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->addPermissionFilter($body, $datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->addPermissionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataExposePermissionFilter->new(); # DataExposePermissionFilter | filter
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->addPermissionFilter(body => $body, datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->addPermissionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
body =  # DataExposePermissionFilter | filter
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # Add Datablock Expose Permission filter
    api_response = api_instance.add_permission_filter(body, datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->addPermissionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


attachPermissionToUsers

Atach users to a Datablock Expose Permission filter


/service/datablocks/{datablockId}/expose/params/filters/{filterId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/expose/params/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        array[String] body = ; // array[String] | attachedUsers
        Long datablockId = 789; // Long | datablockId
        String filterId = filterId_example; // String | filterId
        Long project = 789; // Long | Project id
        try {
            DataExposePermissionFilter result = apiInstance.attachPermissionToUsers(body, datablockId, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#attachPermissionToUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        array[String] body = ; // array[String] | attachedUsers
        Long datablockId = 789; // Long | datablockId
        String filterId = filterId_example; // String | filterId
        Long project = 789; // Long | Project id
        try {
            DataExposePermissionFilter result = apiInstance.attachPermissionToUsers(body, datablockId, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#attachPermissionToUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *body = ; // attachedUsers
Long *datablockId = 789; // datablockId
String *filterId = filterId_example; // filterId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Atach users to a  Datablock Expose Permission filter
[apiInstance attachPermissionToUsersWith:body
    datablockId:datablockId
    filterId:filterId
    project:project
              completionHandler: ^(DataExposePermissionFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var body = ; // {{array[String]}} attachedUsers
var datablockId = 789; // {{Long}} datablockId
var filterId = filterId_example; // {{String}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.attachPermissionToUsers(bodydatablockIdfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class attachPermissionToUsersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var body = new array[String](); // array[String] | attachedUsers
            var datablockId = 789;  // Long | datablockId
            var filterId = filterId_example;  // String | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Atach users to a  Datablock Expose Permission filter
                DataExposePermissionFilter result = apiInstance.attachPermissionToUsers(body, datablockId, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.attachPermissionToUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$body = ; // array[String] | attachedUsers
$datablockId = 789; // Long | datablockId
$filterId = filterId_example; // String | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->attachPermissionToUsers($body, $datablockId, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->attachPermissionToUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | attachedUsers
my $datablockId = 789; # Long | datablockId
my $filterId = filterId_example; # String | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->attachPermissionToUsers(body => $body, datablockId => $datablockId, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->attachPermissionToUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
body =  # array[String] | attachedUsers
datablockId = 789 # Long | datablockId
filterId = filterId_example # String | filterId
project = 789 # Long | Project id (optional)

try: 
    # Atach users to a  Datablock Expose Permission filter
    api_response = api_instance.attach_permission_to_users(body, datablockId, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->attachPermissionToUsers: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
filterId*
String
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteDataBlockExposeParams

delete Datablock Expose Params and exposed data


/service/datablocks/{datablockId}/expose/params

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/datablocks/{datablockId}/expose/params?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDataBlockExposeParams(datablockId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#deleteDataBlockExposeParams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDataBlockExposeParams(datablockId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#deleteDataBlockExposeParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// delete Datablock Expose Params and exposed data
[apiInstance deleteDataBlockExposeParamsWith:datablockId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataBlockExposeParams(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDataBlockExposeParamsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Datablock Expose Params and exposed data
                apiInstance.deleteDataBlockExposeParams(datablockId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.deleteDataBlockExposeParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $api_instance->deleteDataBlockExposeParams($datablockId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->deleteDataBlockExposeParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDataBlockExposeParams(datablockId => $datablockId, project => $project);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->deleteDataBlockExposeParams: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # delete Datablock Expose Params and exposed data
    api_instance.delete_data_block_expose_params(datablockId, project=project)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->deleteDataBlockExposeParams: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteDatablockExpose

Delete Datablock Expose


/service/datablocks/{datablockId}/expose/delete

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/expose/delete?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDatablockExpose(datablockId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#deleteDatablockExpose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDatablockExpose(datablockId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#deleteDatablockExpose");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Delete Datablock Expose
[apiInstance deleteDatablockExposeWith:datablockId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDatablockExpose(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDatablockExposeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete Datablock Expose
                apiInstance.deleteDatablockExpose(datablockId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.deleteDatablockExpose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $api_instance->deleteDatablockExpose($datablockId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->deleteDatablockExpose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDatablockExpose(datablockId => $datablockId, project => $project);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->deleteDatablockExpose: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # Delete Datablock Expose
    api_instance.delete_datablock_expose(datablockId, project=project)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->deleteDatablockExpose: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deletePermissionFilter

delete Datablock Expose Permission filter


/service/datablocks/{datablockId}/expose/params/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/datablocks/{datablockId}/expose/params/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String filterId = filterId_example; // String | filterId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePermissionFilter(datablockId, filterId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#deletePermissionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String filterId = filterId_example; // String | filterId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePermissionFilter(datablockId, filterId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#deletePermissionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
String *filterId = filterId_example; // filterId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// delete Datablock Expose Permission filter
[apiInstance deletePermissionFilterWith:datablockId
    filterId:filterId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var filterId = filterId_example; // {{String}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePermissionFilter(datablockId, filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePermissionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var filterId = filterId_example;  // String | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Datablock Expose Permission filter
                apiInstance.deletePermissionFilter(datablockId, filterId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.deletePermissionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$filterId = filterId_example; // String | filterId
$project = 789; // Long | Project id

try {
    $api_instance->deletePermissionFilter($datablockId, $filterId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->deletePermissionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $filterId = filterId_example; # String | filterId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deletePermissionFilter(datablockId => $datablockId, filterId => $filterId, project => $project);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->deletePermissionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
filterId = filterId_example # String | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Datablock Expose Permission filter
    api_instance.delete_permission_filter(datablockId, filterId, project=project)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->deletePermissionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
filterId*
String
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


disableDataBlockExpose

Disable current Datablock expose


/service/v8/datablocks/{datablockId}/expose/disable

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/{datablockId}/expose/disable?clientId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | clientId
        Long project = 789; // Long | Project id
        try {
            CurrentDataExpose result = apiInstance.disableDataBlockExpose(datablockId, clientId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#disableDataBlockExpose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | clientId
        Long project = 789; // Long | Project id
        try {
            CurrentDataExpose result = apiInstance.disableDataBlockExpose(datablockId, clientId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#disableDataBlockExpose");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
String *clientId = clientId_example; // clientId (optional)
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Disable current Datablock expose
[apiInstance disableDataBlockExposeWith:datablockId
    clientId:clientId
    project:project
              completionHandler: ^(CurrentDataExpose output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'clientId': clientId_example, // {{String}} clientId
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableDataBlockExpose(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disableDataBlockExposeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var clientId = clientId_example;  // String | clientId (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Disable current Datablock expose
                CurrentDataExpose result = apiInstance.disableDataBlockExpose(datablockId, clientId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.disableDataBlockExpose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$clientId = clientId_example; // String | clientId
$project = 789; // Long | Project id

try {
    $result = $api_instance->disableDataBlockExpose($datablockId, $clientId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->disableDataBlockExpose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $clientId = clientId_example; # String | clientId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->disableDataBlockExpose(datablockId => $datablockId, clientId => $clientId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->disableDataBlockExpose: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
clientId = clientId_example # String | clientId (optional)
project = 789 # Long | Project id (optional)

try: 
    # Disable current Datablock expose
    api_response = api_instance.disable_data_block_expose(datablockId, clientId=clientId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->disableDataBlockExpose: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
clientId
String
clientId
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editDatablockExposeParams

edit Datablock Expose Params


/service/datablocks/{datablockId}/expose/params

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/expose/params?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        DataExposeParams body = ; // DataExposeParams | params
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExposeParams result = apiInstance.editDatablockExposeParams(body, datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#editDatablockExposeParams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        DataExposeParams body = ; // DataExposeParams | params
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExposeParams result = apiInstance.editDatablockExposeParams(body, datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#editDatablockExposeParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataExposeParams *body = ; // params
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// edit Datablock Expose Params
[apiInstance editDatablockExposeParamsWith:body
    datablockId:datablockId
    project:project
              completionHandler: ^(DataExposeParams output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var body = ; // {{DataExposeParams}} params
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editDatablockExposeParams(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDatablockExposeParamsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var body = new DataExposeParams(); // DataExposeParams | params
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Datablock Expose Params
                DataExposeParams result = apiInstance.editDatablockExposeParams(body, datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.editDatablockExposeParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$body = ; // DataExposeParams | params
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editDatablockExposeParams($body, $datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->editDatablockExposeParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataExposeParams->new(); # DataExposeParams | params
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editDatablockExposeParams(body => $body, datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->editDatablockExposeParams: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
body =  # DataExposeParams | params
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # edit Datablock Expose Params
    api_response = api_instance.edit_datablock_expose_params(body, datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->editDatablockExposeParams: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editPermissionFilter

Edit Datablock Expose Permission filter


/service/datablocks/{datablockId}/expose/params/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/expose/params/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        DataExposePermissionFilter body = ; // DataExposePermissionFilter | filter
        Long datablockId = 789; // Long | datablockId
        String filterId = filterId_example; // String | filterId
        Long project = 789; // Long | Project id
        try {
            DataExposePermissionFilter result = apiInstance.editPermissionFilter(body, datablockId, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#editPermissionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        DataExposePermissionFilter body = ; // DataExposePermissionFilter | filter
        Long datablockId = 789; // Long | datablockId
        String filterId = filterId_example; // String | filterId
        Long project = 789; // Long | Project id
        try {
            DataExposePermissionFilter result = apiInstance.editPermissionFilter(body, datablockId, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#editPermissionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DataExposePermissionFilter *body = ; // filter
Long *datablockId = 789; // datablockId
String *filterId = filterId_example; // filterId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Edit Datablock Expose Permission filter
[apiInstance editPermissionFilterWith:body
    datablockId:datablockId
    filterId:filterId
    project:project
              completionHandler: ^(DataExposePermissionFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var body = ; // {{DataExposePermissionFilter}} filter
var datablockId = 789; // {{Long}} datablockId
var filterId = filterId_example; // {{String}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editPermissionFilter(bodydatablockIdfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPermissionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var body = new DataExposePermissionFilter(); // DataExposePermissionFilter | filter
            var datablockId = 789;  // Long | datablockId
            var filterId = filterId_example;  // String | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit Datablock Expose Permission filter
                DataExposePermissionFilter result = apiInstance.editPermissionFilter(body, datablockId, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.editPermissionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$body = ; // DataExposePermissionFilter | filter
$datablockId = 789; // Long | datablockId
$filterId = filterId_example; // String | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editPermissionFilter($body, $datablockId, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->editPermissionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $body = WWW::SwaggerClient::Object::DataExposePermissionFilter->new(); # DataExposePermissionFilter | filter
my $datablockId = 789; # Long | datablockId
my $filterId = filterId_example; # String | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editPermissionFilter(body => $body, datablockId => $datablockId, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->editPermissionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
body =  # DataExposePermissionFilter | filter
datablockId = 789 # Long | datablockId
filterId = filterId_example # String | filterId
project = 789 # Long | Project id (optional)

try: 
    # Edit Datablock Expose Permission filter
    api_response = api_instance.edit_permission_filter(body, datablockId, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->editPermissionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
filterId*
String
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


enableDataBlockExpose

Enable current Datablock expose


/service/v8/datablocks/{datablockId}/expose/enable

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/{datablockId}/expose/enable?clientId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | clientId
        Long project = 789; // Long | Project id
        try {
            CurrentDataExpose result = apiInstance.enableDataBlockExpose(datablockId, clientId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#enableDataBlockExpose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | clientId
        Long project = 789; // Long | Project id
        try {
            CurrentDataExpose result = apiInstance.enableDataBlockExpose(datablockId, clientId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#enableDataBlockExpose");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
String *clientId = clientId_example; // clientId (optional)
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Enable current Datablock expose
[apiInstance enableDataBlockExposeWith:datablockId
    clientId:clientId
    project:project
              completionHandler: ^(CurrentDataExpose output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'clientId': clientId_example, // {{String}} clientId
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enableDataBlockExpose(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class enableDataBlockExposeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var clientId = clientId_example;  // String | clientId (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Enable current Datablock expose
                CurrentDataExpose result = apiInstance.enableDataBlockExpose(datablockId, clientId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.enableDataBlockExpose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$clientId = clientId_example; // String | clientId
$project = 789; // Long | Project id

try {
    $result = $api_instance->enableDataBlockExpose($datablockId, $clientId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->enableDataBlockExpose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $clientId = clientId_example; # String | clientId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->enableDataBlockExpose(datablockId => $datablockId, clientId => $clientId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->enableDataBlockExpose: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
clientId = clientId_example # String | clientId (optional)
project = 789 # Long | Project id (optional)

try: 
    # Enable current Datablock expose
    api_response = api_instance.enable_data_block_expose(datablockId, clientId=clientId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->enableDataBlockExpose: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
clientId
String
clientId
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exposeDatablock

Expose Datablock in db


/service/datablocks/{datablockId}/expose/exec

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/expose/exec?clientId=&ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.exposeDatablock(datablockId, clientId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#exposeDatablock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.exposeDatablock(datablockId, clientId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#exposeDatablock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
String *clientId = clientId_example; // clientId (optional)
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Expose Datablock in db
[apiInstance exposeDatablockWith:datablockId
    clientId:clientId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'clientId': clientId_example, // {{String}} clientId
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.exposeDatablock(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exposeDatablockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var clientId = clientId_example;  // String | clientId (optional) 
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Expose Datablock in db
                apiInstance.exposeDatablock(datablockId, clientId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.exposeDatablock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$clientId = clientId_example; // String | clientId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->exposeDatablock($datablockId, $clientId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->exposeDatablock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $clientId = clientId_example; # String | clientId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->exposeDatablock(datablockId => $datablockId, clientId => $clientId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->exposeDatablock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
clientId = clientId_example # String | clientId (optional)
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Expose Datablock in db
    api_instance.expose_datablock(datablockId, clientId=clientId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->exposeDatablock: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
clientId
String
clientId
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockExposureStatus

Get data block Exposure status


/service/datablocks/{datablockId}/expose/check

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/expose/check?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getDataBlockExposureStatus(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDataBlockExposureStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getDataBlockExposureStatus(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDataBlockExposureStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Get data block Exposure status
[apiInstance getDataBlockExposureStatusWith:datablockId
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockExposureStatus(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockExposureStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get data block Exposure status
                'String' result = apiInstance.getDataBlockExposureStatus(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.getDataBlockExposureStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlockExposureStatus($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->getDataBlockExposureStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlockExposureStatus(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->getDataBlockExposureStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # Get data block Exposure status
    api_response = api_instance.get_data_block_exposure_status(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->getDataBlockExposureStatus: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDatablockCurrentExpose

Get Datablock Current Expose


/service/datablocks/{datablockId}/expose/current

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/expose/current?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExpose result = apiInstance.getDatablockCurrentExpose(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDatablockCurrentExpose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExpose result = apiInstance.getDatablockCurrentExpose(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDatablockCurrentExpose");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Get Datablock Current Expose
[apiInstance getDatablockCurrentExposeWith:datablockId
    project:project
              completionHandler: ^(DataExpose output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDatablockCurrentExpose(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDatablockCurrentExposeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get Datablock Current Expose
                DataExpose result = apiInstance.getDatablockCurrentExpose(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.getDatablockCurrentExpose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDatablockCurrentExpose($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->getDatablockCurrentExpose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDatablockCurrentExpose(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->getDatablockCurrentExpose: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # Get Datablock Current Expose
    api_response = api_instance.get_datablock_current_expose(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->getDatablockCurrentExpose: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDatablockExposeHistory

Get Datablock Expose History


/service/datablocks/{datablockId}/expose/history

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/expose/history?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[DataExpose] result = apiInstance.getDatablockExposeHistory(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDatablockExposeHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            array[DataExpose] result = apiInstance.getDatablockExposeHistory(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDatablockExposeHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Get Datablock Expose History
[apiInstance getDatablockExposeHistoryWith:datablockId
    project:project
              completionHandler: ^(array[DataExpose] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDatablockExposeHistory(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDatablockExposeHistoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get Datablock Expose History
                array[DataExpose] result = apiInstance.getDatablockExposeHistory(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.getDatablockExposeHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDatablockExposeHistory($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->getDatablockExposeHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDatablockExposeHistory(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->getDatablockExposeHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # Get Datablock Expose History
    api_response = api_instance.get_datablock_expose_history(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->getDatablockExposeHistory: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDatablockExposeParams

Get Datablock Expose Params


/service/datablocks/{datablockId}/expose/params

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/datablocks/{datablockId}/expose/params?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExposeParams result = apiInstance.getDatablockExposeParams(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDatablockExposeParams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long project = 789; // Long | Project id
        try {
            DataExposeParams result = apiInstance.getDatablockExposeParams(datablockId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDatablockExposeParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *project = 789; // Project id (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Get Datablock Expose Params
[apiInstance getDatablockExposeParamsWith:datablockId
    project:project
              completionHandler: ^(DataExposeParams output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDatablockExposeParams(datablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDatablockExposeParamsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var datablockId = 789;  // Long | datablockId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get Datablock Expose Params
                DataExposeParams result = apiInstance.getDatablockExposeParams(datablockId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.getDatablockExposeParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$datablockId = 789; // Long | datablockId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDatablockExposeParams($datablockId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->getDatablockExposeParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDatablockExposeParams(datablockId => $datablockId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->getDatablockExposeParams: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
datablockId = 789 # Long | datablockId
project = 789 # Long | Project id (optional)

try: 
    # Get Datablock Expose Params
    api_response = api_instance.get_datablock_expose_params(datablockId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->getDatablockExposeParams: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDuplicatedEndpoints

Get Duplicated Endpoints


/service/datablocks/expose/duplicated_endpoints

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/expose/duplicated_endpoints"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataExposeControllerApi;

import java.io.File;
import java.util.*;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        array[String] body = ; // array[String] | Endpoints
        try {
            array['String'] result = apiInstance.getDuplicatedEndpoints(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDuplicatedEndpoints");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataExposeControllerApi;

public class DataExposeControllerApiExample {

    public static void main(String[] args) {
        DataExposeControllerApi apiInstance = new DataExposeControllerApi();
        array[String] body = ; // array[String] | Endpoints
        try {
            array['String'] result = apiInstance.getDuplicatedEndpoints(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataExposeControllerApi#getDuplicatedEndpoints");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *body = ; // Endpoints (optional)

DataExposeControllerApi *apiInstance = [[DataExposeControllerApi alloc] init];

// Get Duplicated Endpoints
[apiInstance getDuplicatedEndpointsWith:body
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataExposeControllerApi()
var opts = { 
  'body':  // {{array[String]}} Endpoints
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDuplicatedEndpoints(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDuplicatedEndpointsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataExposeControllerApi();
            var body = new array[String](); // array[String] | Endpoints (optional) 

            try
            {
                // Get Duplicated Endpoints
                array['String'] result = apiInstance.getDuplicatedEndpoints(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExposeControllerApi.getDuplicatedEndpoints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataExposeControllerApi();
$body = ; // array[String] | Endpoints

try {
    $result = $api_instance->getDuplicatedEndpoints($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataExposeControllerApi->getDuplicatedEndpoints: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataExposeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataExposeControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Endpoints

eval { 
    my $result = $api_instance->getDuplicatedEndpoints(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataExposeControllerApi->getDuplicatedEndpoints: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataExposeControllerApi()
body =  # array[String] | Endpoints (optional)

try: 
    # Get Duplicated Endpoints
    api_response = api_instance.get_duplicated_endpoints(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataExposeControllerApi->getDuplicatedEndpoints: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DataFrameController

cache

Cache a DataFrame


/service/dataframes/{code}/cache

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/cache?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.cache(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#cache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.cache(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#cache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Cache a DataFrame
[apiInstance cacheWith:code
    ctx:ctx
    project:project
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cache(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cacheExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Cache a DataFrame
                JobKeyResponse result = apiInstance.cache(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.cache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->cache($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->cache: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->cache(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->cache: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Cache a DataFrame
    api_response = api_instance.cache(code, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->cache: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataFramePersistenceSize

Get a DataFrame persistence size by code


/service/dataframes/{code}/persist/size

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/persist/size?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getDataFramePersistenceSize(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#getDataFramePersistenceSize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getDataFramePersistenceSize(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#getDataFramePersistenceSize");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Get a DataFrame persistence size by code
[apiInstance getDataFramePersistenceSizeWith:code
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFramePersistenceSize(code, ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataFramePersistenceSizeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a DataFrame persistence size by code
                Long result = apiInstance.getDataFramePersistenceSize(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.getDataFramePersistenceSize: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataFramePersistenceSize($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->getDataFramePersistenceSize: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataFramePersistenceSize(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->getDataFramePersistenceSize: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Get a DataFrame persistence size by code
    api_response = api_instance.get_data_frame_persistence_size(code, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->getDataFramePersistenceSize: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataFrameStatus

Get a DataFrame status by code


/service/dataframes/{code}/status

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/status?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            DataFrameStatus result = apiInstance.getDataFrameStatus(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#getDataFrameStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            DataFrameStatus result = apiInstance.getDataFrameStatus(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#getDataFrameStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Get a DataFrame status by code
[apiInstance getDataFrameStatusWith:code
    ctx:ctx
    project:project
              completionHandler: ^(DataFrameStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFrameStatus(code, ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataFrameStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a DataFrame status by code
                DataFrameStatus result = apiInstance.getDataFrameStatus(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.getDataFrameStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataFrameStatus($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->getDataFrameStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataFrameStatus(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->getDataFrameStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Get a DataFrame status by code
    api_response = api_instance.get_data_frame_status(code, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->getDataFrameStatus: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


persist

Persist a DataFrame


/service/dataframes/{code}/persist

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/persist?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.persist(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#persist");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.persist(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#persist");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Persist a DataFrame
[apiInstance persistWith:code
    ctx:ctx
    project:project
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.persist(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class persistExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Persist a DataFrame
                JobKeyResponse result = apiInstance.persist(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.persist: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->persist($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->persist: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->persist(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->persist: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Persist a DataFrame
    api_response = api_instance.persist(code, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->persist: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


recache

Recache a DataFrame


/service/dataframes/{code}/recache

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/recache?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.recache(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#recache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.recache(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#recache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Recache a DataFrame
[apiInstance recacheWith:code
    ctx:ctx
    project:project
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.recache(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class recacheExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Recache a DataFrame
                JobKeyResponse result = apiInstance.recache(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.recache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->recache($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->recache: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->recache(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->recache: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Recache a DataFrame
    api_response = api_instance.recache(code, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->recache: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


repersist

Repersist a DataFrame


/service/dataframes/{code}/repersist

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/repersist?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.repersist(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#repersist");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.repersist(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#repersist");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Repersist a DataFrame
[apiInstance repersistWith:code
    ctx:ctx
    project:project
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.repersist(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class repersistExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Repersist a DataFrame
                JobKeyResponse result = apiInstance.repersist(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.repersist: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->repersist($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->repersist: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->repersist(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->repersist: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Repersist a DataFrame
    api_response = api_instance.repersist(code, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->repersist: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


uncache

Un-Cache a DataFrame


/service/dataframes/{code}/uncache

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/uncache?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.uncache(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#uncache");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.uncache(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#uncache");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Un-Cache a DataFrame
[apiInstance uncacheWith:code
    ctx:ctx
    project:project
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uncache(code, ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uncacheExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Un-Cache a DataFrame
                JobKeyResponse result = apiInstance.uncache(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.uncache: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->uncache($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->uncache: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->uncache(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->uncache: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Un-Cache a DataFrame
    api_response = api_instance.uncache(code, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->uncache: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


unpersist

Un-Persist and cache a DataFrame


/service/dataframes/{code}/unpersist

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dataframes/{code}/unpersist?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.unpersist(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#unpersist");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        String code = code_example; // String | code
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobKeyResponse result = apiInstance.unpersist(code, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#unpersist");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Un-Persist and cache a DataFrame
[apiInstance unpersistWith:code
    ctx:ctx
    project:project
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var code = code_example; // {{String}} code
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unpersist(code, ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unpersistExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var code = code_example;  // String | code
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Un-Persist and cache a DataFrame
                JobKeyResponse result = apiInstance.unpersist(code, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.unpersist: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$code = code_example; // String | code
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->unpersist($code, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->unpersist: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $code = code_example; # String | code
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->unpersist(code => $code, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->unpersist: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
code = code_example # String | code
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Un-Persist and cache a DataFrame
    api_response = api_instance.unpersist(code, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->unpersist: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


unpersistMany

Un-Persist and cache a list of DataFrames


/service/dataframes/unpersist_many

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/dataframes/unpersist_many?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFrameControllerApi;

import java.io.File;
import java.util.*;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        array[String] body = ; // array[String] | codes
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            map['String', JobKeyResponse] result = apiInstance.unpersistMany(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#unpersistMany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFrameControllerApi;

public class DataFrameControllerApiExample {

    public static void main(String[] args) {
        DataFrameControllerApi apiInstance = new DataFrameControllerApi();
        array[String] body = ; // array[String] | codes
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            map['String', JobKeyResponse] result = apiInstance.unpersistMany(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFrameControllerApi#unpersistMany");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *body = ; // codes
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DataFrameControllerApi *apiInstance = [[DataFrameControllerApi alloc] init];

// Un-Persist and cache a list of DataFrames
[apiInstance unpersistManyWith:body
    ctx:ctx
    project:project
              completionHandler: ^(map['String', JobKeyResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DataFrameControllerApi()
var body = ; // {{array[String]}} codes
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unpersistMany(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unpersistManyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DataFrameControllerApi();
            var body = new array[String](); // array[String] | codes
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Un-Persist and cache a list of DataFrames
                map['String', JobKeyResponse] result = apiInstance.unpersistMany(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFrameControllerApi.unpersistMany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDataFrameControllerApi();
$body = ; // array[String] | codes
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->unpersistMany($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFrameControllerApi->unpersistMany: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFrameControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DataFrameControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | codes
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->unpersistMany(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFrameControllerApi->unpersistMany: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DataFrameControllerApi()
body =  # array[String] | codes
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Un-Persist and cache a list of DataFrames
    api_response = api_instance.unpersist_many(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFrameControllerApi->unpersistMany: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DateMaskController

getDateMasksUsingGET

getDateMasks


/service/date_masks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/date_masks?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DateMaskControllerApi;

import java.io.File;
import java.util.*;

public class DateMaskControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DateMaskControllerApi apiInstance = new DateMaskControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[LabelValue] result = apiInstance.getDateMasksUsingGET(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DateMaskControllerApi#getDateMasksUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DateMaskControllerApi;

public class DateMaskControllerApiExample {

    public static void main(String[] args) {
        DateMaskControllerApi apiInstance = new DateMaskControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[LabelValue] result = apiInstance.getDateMasksUsingGET(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DateMaskControllerApi#getDateMasksUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DateMaskControllerApi *apiInstance = [[DateMaskControllerApi alloc] init];

// getDateMasks
[apiInstance getDateMasksUsingGETWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[LabelValue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DateMaskControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDateMasksUsingGET(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDateMasksUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DateMaskControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // getDateMasks
                array[LabelValue] result = apiInstance.getDateMasksUsingGET(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DateMaskControllerApi.getDateMasksUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDateMaskControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getDateMasksUsingGET($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DateMaskControllerApi->getDateMasksUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DateMaskControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DateMaskControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getDateMasksUsingGET(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DateMaskControllerApi->getDateMasksUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DateMaskControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # getDateMasks
    api_response = api_instance.get_date_masks_using_get(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DateMaskControllerApi->getDateMasksUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDateReadingMasksUsingGET

getDateReadingMasks


/service/date_reading_masks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/date_reading_masks?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DateMaskControllerApi;

import java.io.File;
import java.util.*;

public class DateMaskControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DateMaskControllerApi apiInstance = new DateMaskControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[LabelValue] result = apiInstance.getDateReadingMasksUsingGET(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DateMaskControllerApi#getDateReadingMasksUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DateMaskControllerApi;

public class DateMaskControllerApiExample {

    public static void main(String[] args) {
        DateMaskControllerApi apiInstance = new DateMaskControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[LabelValue] result = apiInstance.getDateReadingMasksUsingGET(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DateMaskControllerApi#getDateReadingMasksUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DateMaskControllerApi *apiInstance = [[DateMaskControllerApi alloc] init];

// getDateReadingMasks
[apiInstance getDateReadingMasksUsingGETWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[LabelValue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DateMaskControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDateReadingMasksUsingGET(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDateReadingMasksUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DateMaskControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // getDateReadingMasks
                array[LabelValue] result = apiInstance.getDateReadingMasksUsingGET(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DateMaskControllerApi.getDateReadingMasksUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDateMaskControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getDateReadingMasksUsingGET($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DateMaskControllerApi->getDateReadingMasksUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DateMaskControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DateMaskControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getDateReadingMasksUsingGET(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DateMaskControllerApi->getDateReadingMasksUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DateMaskControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # getDateReadingMasks
    api_response = api_instance.get_date_reading_masks_using_get(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DateMaskControllerApi->getDateReadingMasksUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DbConnectorController

checkDBConnection

Check a DB connector connectivity


/service/connectors/db/check_connection

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/db/check_connection?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        DBConnector body = ; // DBConnector | dbConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkDBConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#checkDBConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        DBConnector body = ; // DBConnector | dbConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkDBConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#checkDBConnection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DBConnector *body = ; // dbConnector
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// Check a DB connector connectivity
[apiInstance checkDBConnectionWith:body
    ctx:ctx
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var body = ; // {{DBConnector}} dbConnector
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkDBConnection(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkDBConnectionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var body = new DBConnector(); // DBConnector | dbConnector
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check a DB connector connectivity
                'Boolean' result = apiInstance.checkDBConnection(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.checkDBConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$body = ; // DBConnector | dbConnector
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkDBConnection($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->checkDBConnection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::DBConnector->new(); # DBConnector | dbConnector
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkDBConnection(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->checkDBConnection: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
body =  # DBConnector | dbConnector
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Check a DB connector connectivity
    api_response = api_instance.check_db_connection(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->checkDBConnection: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDBConnector

Create a new DB connector

Create a new DB connector and return the created object


/service/connectors/db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        DBConnector body = ; // DBConnector | dbConnector
        Long project = 789; // Long | Project id
        try {
            DBConnector result = apiInstance.createDBConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#createDBConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        DBConnector body = ; // DBConnector | dbConnector
        Long project = 789; // Long | Project id
        try {
            DBConnector result = apiInstance.createDBConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#createDBConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DBConnector *body = ; // dbConnector
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// Create a new DB connector
[apiInstance createDBConnectorWith:body
    project:project
              completionHandler: ^(DBConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var body = ; // {{DBConnector}} dbConnector
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDBConnector(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDBConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var body = new DBConnector(); // DBConnector | dbConnector
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new DB connector
                DBConnector result = apiInstance.createDBConnector(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.createDBConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$body = ; // DBConnector | dbConnector
$project = 789; // Long | Project id

try {
    $result = $api_instance->createDBConnector($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->createDBConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::DBConnector->new(); # DBConnector | dbConnector
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createDBConnector(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->createDBConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
body =  # DBConnector | dbConnector
project = 789 # Long | Project id (optional)

try: 
    # Create a new DB connector
    api_response = api_instance.create_db_connector(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->createDBConnector: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteDBConnector

Delete a DB connector

Delete an existing DB connector for a given ID and return the delete object ID


/service/connectors/db/{connectorId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/connectors/db/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDBConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#deleteDBConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDBConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#deleteDBConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// Delete a DB connector
[apiInstance deleteDBConnectorWith:connectorId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDBConnector(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDBConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a DB connector
                apiInstance.deleteDBConnector(connectorId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.deleteDBConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $api_instance->deleteDBConnector($connectorId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->deleteDBConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDBConnector(connectorId => $connectorId, project => $project);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->deleteDBConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Delete a DB connector
    api_instance.delete_db_connector(connectorId, project=project)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->deleteDBConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDBConnector

Edit a DB connector

Edit an existing DB connector and return the updated object


/service/connectors/db/{connectorId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/db/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        DBConnector body = ; // DBConnector | dbConnector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            DBConnector result = apiInstance.editDBConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#editDBConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        DBConnector body = ; // DBConnector | dbConnector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            DBConnector result = apiInstance.editDBConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#editDBConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DBConnector *body = ; // dbConnector
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// Edit a DB connector
[apiInstance editDBConnectorWith:body
    connectorId:connectorId
    project:project
              completionHandler: ^(DBConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var body = ; // {{DBConnector}} dbConnector
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editDBConnector(bodyconnectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDBConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var body = new DBConnector(); // DBConnector | dbConnector
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a DB connector
                DBConnector result = apiInstance.editDBConnector(body, connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.editDBConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$body = ; // DBConnector | dbConnector
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editDBConnector($body, $connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->editDBConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::DBConnector->new(); # DBConnector | dbConnector
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editDBConnector(body => $body, connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->editDBConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
body =  # DBConnector | dbConnector
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Edit a DB connector
    api_response = api_instance.edit_db_connector(body, connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->editDBConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllDBConnectors

View a list of DB connectors


/service/connectors/db

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[DBConnector] result = apiInstance.findAllDBConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#findAllDBConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[DBConnector] result = apiInstance.findAllDBConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#findAllDBConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// View a list of DB connectors
[apiInstance findAllDBConnectorsWith:project
              completionHandler: ^(array[DBConnector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllDBConnectors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllDBConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of DB connectors
                array[DBConnector] result = apiInstance.findAllDBConnectors(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.findAllDBConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllDBConnectors($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->findAllDBConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllDBConnectors(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->findAllDBConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of DB connectors
    api_response = api_instance.find_all_db_connectors(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->findAllDBConnectors: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneDBConnectorById

Get a DB connector by ID


/service/connectors/db/{connectorId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/db/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            DBConnector result = apiInstance.findOneDBConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#findOneDBConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            DBConnector result = apiInstance.findOneDBConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#findOneDBConnectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// Get a DB connector by ID
[apiInstance findOneDBConnectorByIdWith:connectorId
    project:project
              completionHandler: ^(DBConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneDBConnectorById(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneDBConnectorByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a DB connector by ID
                DBConnector result = apiInstance.findOneDBConnectorById(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.findOneDBConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneDBConnectorById($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->findOneDBConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneDBConnectorById(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->findOneDBConnectorById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Get a DB connector by ID
    api_response = api_instance.find_one_db_connector_by_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->findOneDBConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongodbCollections

CGet Mongodb available collections


/service/connectors/db/{connectorId}/mongodb_collections

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/db/{connectorId}/mongodb_collections?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbConnectorControllerApi;

import java.io.File;
import java.util.*;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getMongodbCollections(connectorId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#getMongodbCollections");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbConnectorControllerApi;

public class DbConnectorControllerApiExample {

    public static void main(String[] args) {
        DbConnectorControllerApi apiInstance = new DbConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getMongodbCollections(connectorId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbConnectorControllerApi#getMongodbCollections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DbConnectorControllerApi *apiInstance = [[DbConnectorControllerApi alloc] init];

// CGet Mongodb available collections
[apiInstance getMongodbCollectionsWith:connectorId
    ctx:ctx
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongodbCollections(connectorId, ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongodbCollectionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // CGet Mongodb available collections
                array['String'] result = apiInstance.getMongodbCollections(connectorId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbConnectorControllerApi.getMongodbCollections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMongodbCollections($connectorId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbConnectorControllerApi->getMongodbCollections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMongodbCollections(connectorId => $connectorId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbConnectorControllerApi->getMongodbCollections: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbConnectorControllerApi()
connectorId = 789 # Long | connectorId
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # CGet Mongodb available collections
    api_response = api_instance.get_mongodb_collections(connectorId, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbConnectorControllerApi->getMongodbCollections: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


DbSqlDepotController

createDbSQLDepot

Create a Database SQL depot by id


/service/depots/db_sql

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            DbSQLDepot result = apiInstance.createDbSQLDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            DbSQLDepot result = apiInstance.createDbSQLDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DbSQLDepot *body = ; // dbSQLDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Create a Database SQL depot by id
[apiInstance createDbSQLDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(DbSQLDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{DbSQLDepot}} dbSQLDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDbSQLDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDbSQLDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new DbSQLDepot(); // DbSQLDepot | dbSQLDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Create a Database SQL depot by id
                DbSQLDepot result = apiInstance.createDbSQLDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.createDbSQLDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // DbSQLDepot | dbSQLDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createDbSQLDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->createDbSQLDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DbSQLDepot->new(); # DbSQLDepot | dbSQLDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createDbSQLDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->createDbSQLDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # DbSQLDepot | dbSQLDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Create a Database SQL depot by id
    api_response = api_instance.create_db_sql_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->createDbSQLDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDbSQLDepotHeader

create Depot Header


/service/depots/db_sql/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createDbSQLDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createDbSQLDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createDbSQLDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDbSQLDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDbSQLDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createDbSQLDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.createDbSQLDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createDbSQLDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->createDbSQLDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createDbSQLDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->createDbSQLDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_db_sql_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->createDbSQLDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDbSQLExtraction

create Extraction


/service/depots/db_sql/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createDbSQLExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createDbSQLExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// create Extraction
[apiInstance createDbSQLExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createDbSQLExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDbSQLExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createDbSQLExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.createDbSQLExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createDbSQLExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->createDbSQLExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createDbSQLExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->createDbSQLExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_db_sql_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->createDbSQLExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createDbSQLExtractionFilter

create Extraction Filter


/service/depots/db_sql/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createDbSQLExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createDbSQLExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#createDbSQLExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createDbSQLExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDbSQLExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDbSQLExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createDbSQLExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.createDbSQLExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createDbSQLExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->createDbSQLExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createDbSQLExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->createDbSQLExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_db_sql_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->createDbSQLExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllDbSQLDepotHeader

delete All Depot Header


/service/depots/db_sql/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/db_sql/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllDbSQLDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteAllDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllDbSQLDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteAllDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllDbSQLDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllDbSQLDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllDbSQLDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllDbSQLDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.deleteAllDbSQLDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllDbSQLDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->deleteAllDbSQLDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllDbSQLDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->deleteAllDbSQLDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_db_sql_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->deleteAllDbSQLDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteDbSQLDepot

Delete a Database SQL depot


/service/depots/db_sql/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/db_sql/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDbSQLDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDbSQLDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Delete a Database SQL depot
[apiInstance deleteDbSQLDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDbSQLDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDbSQLDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a Database SQL depot
                apiInstance.deleteDbSQLDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.deleteDbSQLDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteDbSQLDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->deleteDbSQLDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDbSQLDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->deleteDbSQLDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Delete a Database SQL depot
    api_instance.delete_db_sql_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->deleteDbSQLDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteDbSQLDepotHeader

delete Depot Header


/service/depots/db_sql/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteDbSQLDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteDbSQLDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteDbSQLDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDbSQLDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDbSQLDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteDbSQLDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.deleteDbSQLDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteDbSQLDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->deleteDbSQLDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteDbSQLDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->deleteDbSQLDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_db_sql_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->deleteDbSQLDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteDbSQLExtraction

deleteExtraction


/service/depots/db_sql/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/db_sql/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDbSQLExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteDbSQLExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// deleteExtraction
[apiInstance deleteDbSQLExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDbSQLExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDbSQLExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // deleteExtraction
                apiInstance.deleteDbSQLExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.deleteDbSQLExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteDbSQLExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->deleteDbSQLExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteDbSQLExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->deleteDbSQLExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # deleteExtraction
    api_instance.delete_db_sql_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->deleteDbSQLExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteDbSQLExtractionFilter

delete Extraction Filter


/service/depots/db_sql/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteDbSQLExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteDbSQLExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#deleteDbSQLExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteDbSQLExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDbSQLExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDbSQLExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteDbSQLExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.deleteDbSQLExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteDbSQLExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->deleteDbSQLExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteDbSQLExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->deleteDbSQLExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_db_sql_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->deleteDbSQLExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDbSQLDepot

Edit a Database SQL depot


/service/depots/db_sql/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DbSQLDepot result = apiInstance.editDbSQLDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#editDbSQLDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DbSQLDepot result = apiInstance.editDbSQLDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#editDbSQLDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DbSQLDepot *body = ; // dbSQLDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Edit a Database SQL depot
[apiInstance editDbSQLDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DbSQLDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{DbSQLDepot}} dbSQLDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editDbSQLDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDbSQLDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new DbSQLDepot(); // DbSQLDepot | dbSQLDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a Database SQL depot
                DbSQLDepot result = apiInstance.editDbSQLDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.editDbSQLDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // DbSQLDepot | dbSQLDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editDbSQLDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->editDbSQLDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DbSQLDepot->new(); # DbSQLDepot | dbSQLDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editDbSQLDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->editDbSQLDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # DbSQLDepot | dbSQLDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Edit a Database SQL depot
    api_response = api_instance.edit_db_sql_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->editDbSQLDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDbSQLDepotHeader

edit Depot Header


/service/depots/db_sql/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editDbSQLDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#editDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editDbSQLDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#editDbSQLDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editDbSQLDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editDbSQLDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDbSQLDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editDbSQLDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.editDbSQLDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editDbSQLDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->editDbSQLDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editDbSQLDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->editDbSQLDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_db_sql_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->editDbSQLDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editDbSQLExtractionFilter

edit Extraction Filter


/service/depots/db_sql/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editDbSQLExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#editDbSQLExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editDbSQLExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#editDbSQLExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editDbSQLExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editDbSQLExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editDbSQLExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editDbSQLExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.editDbSQLExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editDbSQLExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->editDbSQLExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editDbSQLExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->editDbSQLExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_db_sql_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->editDbSQLExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllDbSQLDepot

View a list of Database SQL depots


/service/depots/db_sql

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[DbSQLDepot] result = apiInstance.findAllDbSQLDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#findAllDbSQLDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[DbSQLDepot] result = apiInstance.findAllDbSQLDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#findAllDbSQLDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// View a list of Database SQL depots
[apiInstance findAllDbSQLDepotWith:project
              completionHandler: ^(array[DbSQLDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllDbSQLDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllDbSQLDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of Database SQL depots
                array[DbSQLDepot] result = apiInstance.findAllDbSQLDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.findAllDbSQLDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllDbSQLDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->findAllDbSQLDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllDbSQLDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->findAllDbSQLDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of Database SQL depots
    api_response = api_instance.find_all_db_sql_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->findAllDbSQLDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllDbSQLExtractionFilters

find All Extraction Filters


/service/depots/db_sql/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllDbSQLExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#findAllDbSQLExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllDbSQLExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#findAllDbSQLExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllDbSQLExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllDbSQLExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllDbSQLExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllDbSQLExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.findAllDbSQLExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllDbSQLExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->findAllDbSQLExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllDbSQLExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->findAllDbSQLExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_db_sql_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->findAllDbSQLExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneDbSQLDepotById

Get a Database SQL depot by id


/service/depots/db_sql/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            DbSQLDepot result = apiInstance.findOneDbSQLDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#findOneDbSQLDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            DbSQLDepot result = apiInstance.findOneDbSQLDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#findOneDbSQLDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Get a Database SQL depot by id
[apiInstance findOneDbSQLDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(DbSQLDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneDbSQLDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneDbSQLDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // Get a Database SQL depot by id
                DbSQLDepot result = apiInstance.findOneDbSQLDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.findOneDbSQLDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneDbSQLDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->findOneDbSQLDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneDbSQLDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->findOneDbSQLDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # Get a Database SQL depot by id
    api_response = api_instance.find_one_db_sql_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->findOneDbSQLDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDbHeadersFromDepot

Get headers from a Database SQL depot


/service/depots/db_sql/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/headers?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getDbHeadersFromDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbHeadersFromDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getDbHeadersFromDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbHeadersFromDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DbSQLDepot *body = ; // dbSQLDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Get headers from a Database SQL depot
[apiInstance getDbHeadersFromDepotWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{DbSQLDepot}} dbSQLDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDbHeadersFromDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDbHeadersFromDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new DbSQLDepot(); // DbSQLDepot | dbSQLDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a Database SQL depot
                array[array[Object]] result = apiInstance.getDbHeadersFromDepot(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.getDbHeadersFromDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // DbSQLDepot | dbSQLDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDbHeadersFromDepot($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->getDbHeadersFromDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DbSQLDepot->new(); # DbSQLDepot | dbSQLDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDbHeadersFromDepot(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->getDbHeadersFromDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # DbSQLDepot | dbSQLDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a Database SQL depot
    api_response = api_instance.get_db_headers_from_depot(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->getDbHeadersFromDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDbSQLDataPreview

Get a preview from a Database SQL depot


/service/depots/db_sql/preview

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/preview?ctx=&project=&useCache=&withData="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        Boolean withData = true; // Boolean | withData
        try {
            DepotData result = apiInstance.getDbSQLDataPreview(body, ctx, project, useCache, withData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLDataPreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        DbSQLDepot body = ; // DbSQLDepot | dbSQLDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        Boolean withData = true; // Boolean | withData
        try {
            DepotData result = apiInstance.getDbSQLDataPreview(body, ctx, project, useCache, withData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLDataPreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DbSQLDepot *body = ; // dbSQLDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)
Boolean *withData = true; // withData (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Get a preview from a Database SQL depot
[apiInstance getDbSQLDataPreviewWith:body
    ctx:ctx
    project:project
    useCache:useCache
    withData:withData
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{DbSQLDepot}} dbSQLDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
  'withData': true // {{Boolean}} withData
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDbSQLDataPreview(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDbSQLDataPreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new DbSQLDepot(); // DbSQLDepot | dbSQLDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 
            var withData = true;  // Boolean | withData (optional) 

            try
            {
                // Get a preview from a Database SQL depot
                DepotData result = apiInstance.getDbSQLDataPreview(body, ctx, project, useCache, withData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.getDbSQLDataPreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // DbSQLDepot | dbSQLDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache
$withData = true; // Boolean | withData

try {
    $result = $api_instance->getDbSQLDataPreview($body, $ctx, $project, $useCache, $withData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->getDbSQLDataPreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DbSQLDepot->new(); # DbSQLDepot | dbSQLDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache
my $withData = true; # Boolean | withData

eval { 
    my $result = $api_instance->getDbSQLDataPreview(body => $body, ctx => $ctx, project => $project, useCache => $useCache, withData => $withData);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->getDbSQLDataPreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # DbSQLDepot | dbSQLDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)
withData = true # Boolean | withData (optional)

try: 
    # Get a preview from a Database SQL depot
    api_response = api_instance.get_db_sql_data_preview(body, ctx, project=project, useCache=useCache, withData=withData)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->getDbSQLDataPreview: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
useCache
Boolean
useCache
withData
Boolean
withData

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDbSQLDepotExtractions

get Depot Extractions


/service/depots/db_sql/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getDbSQLDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getDbSQLDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getDbSQLDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDbSQLDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDbSQLDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getDbSQLDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.getDbSQLDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDbSQLDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->getDbSQLDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDbSQLDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->getDbSQLDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_db_sql_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->getDbSQLDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDbSQLDepotHeadersByDepotId

get Depot Headers By Depot Id


/service/depots/db_sql/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getDbSQLDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getDbSQLDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// get Depot Headers By Depot Id
[apiInstance getDbSQLDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDbSQLDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDbSQLDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By Depot Id
                array[DepotHeader] result = apiInstance.getDbSQLDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.getDbSQLDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDbSQLDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->getDbSQLDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDbSQLDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->getDbSQLDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By Depot Id
    api_response = api_instance.get_db_sql_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->getDbSQLDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDbSQLExtractionFilePreview

getExtractionFilePreview


/service/depots/db_sql/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getDbSQLExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getDbSQLExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getDbSQLExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// getExtractionFilePreview
[apiInstance getDbSQLExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDbSQLExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDbSQLExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getExtractionFilePreview
                DepotData result = apiInstance.getDbSQLExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.getDbSQLExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getDbSQLExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->getDbSQLExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getDbSQLExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->getDbSQLExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getExtractionFilePreview
    api_response = api_instance.get_db_sql_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->getDbSQLExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getSqlPreviewDepot

Get SQL depot preview


/service/depots/db_sql/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/db_sql/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getSqlPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getSqlPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getSqlPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#getSqlPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// Get SQL depot preview
[apiInstance getSqlPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSqlPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSqlPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get SQL depot preview
                DepotData result = apiInstance.getSqlPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.getSqlPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getSqlPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->getSqlPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getSqlPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->getSqlPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get SQL depot preview
    api_response = api_instance.get_sql_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->getSqlPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateDbSQLDepotActivationStatus

update Depot Activation Status


/service/depots/db_sql/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/db_sql/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateDbSQLDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#updateDbSQLDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateDbSQLDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#updateDbSQLDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateDbSQLDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateDbSQLDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateDbSQLDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateDbSQLDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.updateDbSQLDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateDbSQLDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->updateDbSQLDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateDbSQLDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->updateDbSQLDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_db_sql_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->updateDbSQLDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateDbSQLDepotHeadersPositions

update Depot Headers Positions


/service/depots/db_sql/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/db_sql/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DbSqlDepotControllerApi;

import java.io.File;
import java.util.*;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateDbSQLDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#updateDbSQLDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DbSqlDepotControllerApi;

public class DbSqlDepotControllerApiExample {

    public static void main(String[] args) {
        DbSqlDepotControllerApi apiInstance = new DbSqlDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateDbSQLDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbSqlDepotControllerApi#updateDbSQLDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

DbSqlDepotControllerApi *apiInstance = [[DbSqlDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateDbSQLDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DbSqlDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateDbSQLDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateDbSQLDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DbSqlDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateDbSQLDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DbSqlDepotControllerApi.updateDbSQLDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDbSqlDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateDbSQLDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling DbSqlDepotControllerApi->updateDbSQLDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DbSqlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DbSqlDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateDbSQLDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling DbSqlDepotControllerApi->updateDbSQLDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DbSqlDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_db_sql_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling DbSqlDepotControllerApi->updateDbSQLDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


DcGraphController

getGraphUsingPOST

getGraph


/service/hdh_graph

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/hdh_graph?axe=&filteredId=&filteredType=&project=&withPersistenceInfo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DcGraphControllerApi;

import java.io.File;
import java.util.*;

public class DcGraphControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DcGraphControllerApi apiInstance = new DcGraphControllerApi();
        map[String, array[Long]] body = ; // map[String, array[Long]] | filter
        String axe = axe_example; // String | Axe
        Long filteredId = 789; // Long | filteredId
        String filteredType = filteredType_example; // String | Filtered element type
        Long project = 789; // Long | Project id
        Boolean withPersistenceInfo = true; // Boolean | With persistence info
        try {
            NodeEdges result = apiInstance.getGraphUsingPOST(body, axe, filteredId, filteredType, project, withPersistenceInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DcGraphControllerApi#getGraphUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DcGraphControllerApi;

public class DcGraphControllerApiExample {

    public static void main(String[] args) {
        DcGraphControllerApi apiInstance = new DcGraphControllerApi();
        map[String, array[Long]] body = ; // map[String, array[Long]] | filter
        String axe = axe_example; // String | Axe
        Long filteredId = 789; // Long | filteredId
        String filteredType = filteredType_example; // String | Filtered element type
        Long project = 789; // Long | Project id
        Boolean withPersistenceInfo = true; // Boolean | With persistence info
        try {
            NodeEdges result = apiInstance.getGraphUsingPOST(body, axe, filteredId, filteredType, project, withPersistenceInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DcGraphControllerApi#getGraphUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
map[String, array[Long]] *body = ; // filter
String *axe = axe_example; // Axe (optional)
Long *filteredId = 789; // filteredId (optional)
String *filteredType = filteredType_example; // Filtered element type (optional)
Long *project = 789; // Project id (optional)
Boolean *withPersistenceInfo = true; // With persistence info (optional)

DcGraphControllerApi *apiInstance = [[DcGraphControllerApi alloc] init];

// getGraph
[apiInstance getGraphUsingPOSTWith:body
    axe:axe
    filteredId:filteredId
    filteredType:filteredType
    project:project
    withPersistenceInfo:withPersistenceInfo
              completionHandler: ^(NodeEdges output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DcGraphControllerApi()
var body = ; // {{map[String, array[Long]]}} filter
var opts = { 
  'axe': axe_example // {{String}} Axe
  'filteredId': 789 // {{Long}} filteredId
  'filteredType': filteredType_example // {{String}} Filtered element type
  'project': 789 // {{Long}} Project id
  'withPersistenceInfo': true // {{Boolean}} With persistence info
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphUsingPOST(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGraphUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DcGraphControllerApi();
            var body = new map[String, array[Long]](); // map[String, array[Long]] | filter
            var axe = axe_example;  // String | Axe (optional) 
            var filteredId = 789;  // Long | filteredId (optional) 
            var filteredType = filteredType_example;  // String | Filtered element type (optional) 
            var project = 789;  // Long | Project id (optional) 
            var withPersistenceInfo = true;  // Boolean | With persistence info (optional) 

            try
            {
                // getGraph
                NodeEdges result = apiInstance.getGraphUsingPOST(body, axe, filteredId, filteredType, project, withPersistenceInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DcGraphControllerApi.getGraphUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDcGraphControllerApi();
$body = ; // map[String, array[Long]] | filter
$axe = axe_example; // String | Axe
$filteredId = 789; // Long | filteredId
$filteredType = filteredType_example; // String | Filtered element type
$project = 789; // Long | Project id
$withPersistenceInfo = true; // Boolean | With persistence info

try {
    $result = $api_instance->getGraphUsingPOST($body, $axe, $filteredId, $filteredType, $project, $withPersistenceInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DcGraphControllerApi->getGraphUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DcGraphControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DcGraphControllerApi->new();
my $body = WWW::SwaggerClient::Object::map[String, array[Long]]->new(); # map[String, array[Long]] | filter
my $axe = axe_example; # String | Axe
my $filteredId = 789; # Long | filteredId
my $filteredType = filteredType_example; # String | Filtered element type
my $project = 789; # Long | Project id
my $withPersistenceInfo = true; # Boolean | With persistence info

eval { 
    my $result = $api_instance->getGraphUsingPOST(body => $body, axe => $axe, filteredId => $filteredId, filteredType => $filteredType, project => $project, withPersistenceInfo => $withPersistenceInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DcGraphControllerApi->getGraphUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DcGraphControllerApi()
body =  # map[String, array[Long]] | filter
axe = axe_example # String | Axe (optional)
filteredId = 789 # Long | filteredId (optional)
filteredType = filteredType_example # String | Filtered element type (optional)
project = 789 # Long | Project id (optional)
withPersistenceInfo = true # Boolean | With persistence info (optional)

try: 
    # getGraph
    api_response = api_instance.get_graph_using_post(body, axe=axe, filteredId=filteredId, filteredType=filteredType, project=project, withPersistenceInfo=withPersistenceInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DcGraphControllerApi->getGraphUsingPOST: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
axe
String
Axe
filteredId
Long (int64)
filteredId
filteredType
String
Filtered element type
project
Long (int64)
Project id
withPersistenceInfo
Boolean
With persistence info

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


Deprecated

downloadFileByPath

Download File by path

This endpoint is no longer supported (since 8.2.0). Use file/token to get a download token and file/download to execute the download.


/service/file_download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/file_download?ctx=&filePath=&isNotOnHDFS="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        Integer ctx = 56; // Integer | ctx
        String filePath = filePath_example; // String | filePath
        Boolean isNotOnHDFS = true; // Boolean | isNotOnHDFS
        try {
            apiInstance.downloadFileByPath(ctx, filePath, isNotOnHDFS);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#downloadFileByPath");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        Integer ctx = 56; // Integer | ctx
        String filePath = filePath_example; // String | filePath
        Boolean isNotOnHDFS = true; // Boolean | isNotOnHDFS
        try {
            apiInstance.downloadFileByPath(ctx, filePath, isNotOnHDFS);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#downloadFileByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *filePath = filePath_example; // filePath
Boolean *isNotOnHDFS = true; // isNotOnHDFS (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// Download File by path
[apiInstance downloadFileByPathWith:ctx
    filePath:filePath
    isNotOnHDFS:isNotOnHDFS
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var ctx = 56; // {{Integer}} ctx
var filePath = filePath_example; // {{String}} filePath
var opts = { 
  'isNotOnHDFS': true // {{Boolean}} isNotOnHDFS
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadFileByPath(ctx, filePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadFileByPathExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var ctx = 56;  // Integer | ctx
            var filePath = filePath_example;  // String | filePath
            var isNotOnHDFS = true;  // Boolean | isNotOnHDFS (optional) 

            try
            {
                // Download File by path
                apiInstance.downloadFileByPath(ctx, filePath, isNotOnHDFS);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.downloadFileByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$ctx = 56; // Integer | ctx
$filePath = filePath_example; // String | filePath
$isNotOnHDFS = true; // Boolean | isNotOnHDFS

try {
    $api_instance->downloadFileByPath($ctx, $filePath, $isNotOnHDFS);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->downloadFileByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $ctx = 56; # Integer | ctx
my $filePath = filePath_example; # String | filePath
my $isNotOnHDFS = true; # Boolean | isNotOnHDFS

eval { 
    $api_instance->downloadFileByPath(ctx => $ctx, filePath => $filePath, isNotOnHDFS => $isNotOnHDFS);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->downloadFileByPath: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
ctx = 56 # Integer | ctx
filePath = filePath_example # String | filePath
isNotOnHDFS = true # Boolean | isNotOnHDFS (optional)

try: 
    # Download File by path
    api_instance.download_file_by_path(ctx, filePath, isNotOnHDFS=isNotOnHDFS)
except ApiException as e:
    print("Exception when calling DeprecatedApi->downloadFileByPath: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filePath*
String
filePath
Required
isNotOnHDFS
Boolean
isNotOnHDFS

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToCSVAsync

exportDataBlockToCSVAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/csv

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/csv?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToCSVRequest body = ; // ExportToCSVRequest | exportToCSVRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToCSVAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToCSVAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToCSVRequest body = ; // ExportToCSVRequest | exportToCSVRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToCSVAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToCSVAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToCSVRequest *body = ; // exportToCSVRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToCSVAsync
[apiInstance exportDataBlockToCSVAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToCSVRequest}} exportToCSVRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToCSVAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToCSVAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToCSVRequest(); // ExportToCSVRequest | exportToCSVRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToCSVAsync
                Long result = apiInstance.exportDataBlockToCSVAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToCSVAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToCSVRequest | exportToCSVRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToCSVAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToCSVAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToCSVRequest->new(); # ExportToCSVRequest | exportToCSVRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToCSVAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToCSVAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToCSVRequest | exportToCSVRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToCSVAsync
    api_response = api_instance.export_data_block_to_csv_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToCSVAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToDbAsync

exportDataBlockToDbAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/db?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToDbRequest body = ; // ExportToDbRequest | exportToDbRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToDbAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToDbAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToDbRequest body = ; // ExportToDbRequest | exportToDbRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToDbAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToDbAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToDbRequest *body = ; // exportToDbRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToDbAsync
[apiInstance exportDataBlockToDbAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToDbRequest}} exportToDbRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToDbAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToDbAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToDbRequest(); // ExportToDbRequest | exportToDbRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToDbAsync
                Long result = apiInstance.exportDataBlockToDbAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToDbAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToDbRequest | exportToDbRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToDbAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToDbAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToDbRequest->new(); # ExportToDbRequest | exportToDbRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToDbAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToDbAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToDbRequest | exportToDbRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToDbAsync
    api_response = api_instance.export_data_block_to_db_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToDbAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToExcelAsync

exportDataBlockToExcelAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/excel

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/excel?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToExcelRequest body = ; // ExportToExcelRequest | exportToExcelRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToExcelAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToExcelAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToExcelRequest body = ; // ExportToExcelRequest | exportToExcelRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToExcelAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToExcelAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToExcelRequest *body = ; // exportToExcelRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToExcelAsync
[apiInstance exportDataBlockToExcelAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToExcelRequest}} exportToExcelRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToExcelAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToExcelAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToExcelRequest(); // ExportToExcelRequest | exportToExcelRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToExcelAsync
                Long result = apiInstance.exportDataBlockToExcelAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToExcelAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToExcelRequest | exportToExcelRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToExcelAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToExcelAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToExcelRequest->new(); # ExportToExcelRequest | exportToExcelRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToExcelAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToExcelAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToExcelRequest | exportToExcelRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToExcelAsync
    api_response = api_instance.export_data_block_to_excel_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToExcelAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToJsonAsync

exportDataBlockToJsonAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/json

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/json?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToFileRequest body = ; // ExportToFileRequest | exportToFileRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToJsonAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToJsonAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToFileRequest body = ; // ExportToFileRequest | exportToFileRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToJsonAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToJsonAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToFileRequest *body = ; // exportToFileRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToJsonAsync
[apiInstance exportDataBlockToJsonAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToFileRequest}} exportToFileRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToJsonAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToJsonAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToFileRequest(); // ExportToFileRequest | exportToFileRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToJsonAsync
                Long result = apiInstance.exportDataBlockToJsonAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToJsonAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToFileRequest | exportToFileRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToJsonAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToJsonAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToFileRequest->new(); # ExportToFileRequest | exportToFileRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToJsonAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToJsonAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToFileRequest | exportToFileRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToJsonAsync
    api_response = api_instance.export_data_block_to_json_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToJsonAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToNeo4jAsync

exportDataBlockToNeo4jAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/db/neo4j

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/db/neo4j?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToNeo4jRequest body = ; // ExportToNeo4jRequest | exportToNeo4jRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToNeo4jAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToNeo4jAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToNeo4jRequest body = ; // ExportToNeo4jRequest | exportToNeo4jRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToNeo4jAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToNeo4jAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToNeo4jRequest *body = ; // exportToNeo4jRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToNeo4jAsync
[apiInstance exportDataBlockToNeo4jAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToNeo4jRequest}} exportToNeo4jRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToNeo4jAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToNeo4jAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToNeo4jRequest(); // ExportToNeo4jRequest | exportToNeo4jRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToNeo4jAsync
                Long result = apiInstance.exportDataBlockToNeo4jAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToNeo4jAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToNeo4jRequest | exportToNeo4jRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToNeo4jAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToNeo4jAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToNeo4jRequest->new(); # ExportToNeo4jRequest | exportToNeo4jRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToNeo4jAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToNeo4jAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToNeo4jRequest | exportToNeo4jRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToNeo4jAsync
    api_response = api_instance.export_data_block_to_neo4j_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToNeo4jAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToParquetAsync

exportDataBlockToParquetAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/parquet

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/parquet?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToFileRequest body = ; // ExportToFileRequest | exportToFileRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToParquetAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToParquetAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToFileRequest body = ; // ExportToFileRequest | exportToFileRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToParquetAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToParquetAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToFileRequest *body = ; // exportToFileRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToParquetAsync
[apiInstance exportDataBlockToParquetAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToFileRequest}} exportToFileRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToParquetAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToParquetAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToFileRequest(); // ExportToFileRequest | exportToFileRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToParquetAsync
                Long result = apiInstance.exportDataBlockToParquetAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToParquetAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToFileRequest | exportToFileRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToParquetAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToParquetAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToFileRequest->new(); # ExportToFileRequest | exportToFileRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToParquetAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToParquetAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToFileRequest | exportToFileRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToParquetAsync
    api_response = api_instance.export_data_block_to_parquet_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToParquetAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportDataBlockToXMLAsync

exportDataBlockToXMLAsync

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/{datablockId}/export instead.


/service/datablocks/{datablockId}/export/xml

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/datablocks/{datablockId}/export/xml?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedApi;

import java.io.File;
import java.util.*;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToXMLRequest body = ; // ExportToXMLRequest | exportToXMLRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToXMLAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToXMLAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedApi;

public class DeprecatedApiExample {

    public static void main(String[] args) {
        DeprecatedApi apiInstance = new DeprecatedApi();
        ExportToXMLRequest body = ; // ExportToXMLRequest | exportToXMLRequest
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.exportDataBlockToXMLAsync(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedApi#exportDataBlockToXMLAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportToXMLRequest *body = ; // exportToXMLRequest
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

DeprecatedApi *apiInstance = [[DeprecatedApi alloc] init];

// exportDataBlockToXMLAsync
[apiInstance exportDataBlockToXMLAsyncWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.DeprecatedApi()
var body = ; // {{ExportToXMLRequest}} exportToXMLRequest
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportDataBlockToXMLAsync(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportDataBlockToXMLAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeprecatedApi();
            var body = new ExportToXMLRequest(); // ExportToXMLRequest | exportToXMLRequest
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // exportDataBlockToXMLAsync
                Long result = apiInstance.exportDataBlockToXMLAsync(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedApi.exportDataBlockToXMLAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeprecatedApi();
$body = ; // ExportToXMLRequest | exportToXMLRequest
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->exportDataBlockToXMLAsync($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedApi->exportDataBlockToXMLAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeprecatedApi->new();
my $body = WWW::SwaggerClient::Object::ExportToXMLRequest->new(); # ExportToXMLRequest | exportToXMLRequest
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->exportDataBlockToXMLAsync(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedApi->exportDataBlockToXMLAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeprecatedApi()
body =  # ExportToXMLRequest | exportToXMLRequest
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # exportDataBlockToXMLAsync
    api_response = api_instance.export_data_block_to_xml_async(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedApi->exportDataBlockToXMLAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


EntiteTypeController

createEntite

Create a new Entite

Create a new Entite and return the new generated Id.


/service/entites

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entites?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntityEntry body = ; // EntityEntry | The Entite data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createEntite(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#createEntite");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntityEntry body = ; // EntityEntry | The Entite data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createEntite(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#createEntite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
EntityEntry *body = ; // The Entite data (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Create a new Entite
[apiInstance createEntiteWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var opts = { 
  'body':  // {{EntityEntry}} The Entite data
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEntite(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createEntiteExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new EntityEntry(); // EntityEntry | The Entite data (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new Entite
                Long result = apiInstance.createEntite(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.createEntite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // EntityEntry | The Entite data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createEntite($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->createEntite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = WWW::SwaggerClient::Object::EntityEntry->new(); # EntityEntry | The Entite data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createEntite(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->createEntite: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # EntityEntry | The Entite data (optional)
project = 789 # Long | Project id (optional)

try: 
    # Create a new Entite
    api_response = api_instance.create_entite(body=body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->createEntite: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createEntiteTypeWithCaracAndMappingFromDepot

createEntiteTypeWithCaracAndMappingFromDepot


/service/entite_types/create/from_depot/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/create/from_depot/{depotId}?createRepDetails=&prefix=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long depotId = 789; // Long | depotId
        Boolean createRepDetails = true; // Boolean | createRepDetails
        String prefix = prefix_example; // String | prefix
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createEntiteTypeWithCaracAndMappingFromDepot(depotId, createRepDetails, prefix, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#createEntiteTypeWithCaracAndMappingFromDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long depotId = 789; // Long | depotId
        Boolean createRepDetails = true; // Boolean | createRepDetails
        String prefix = prefix_example; // String | prefix
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createEntiteTypeWithCaracAndMappingFromDepot(depotId, createRepDetails, prefix, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#createEntiteTypeWithCaracAndMappingFromDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Boolean *createRepDetails = true; // createRepDetails (optional)
String *prefix = prefix_example; // prefix (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// createEntiteTypeWithCaracAndMappingFromDepot
[apiInstance createEntiteTypeWithCaracAndMappingFromDepotWith:depotId
    createRepDetails:createRepDetails
    prefix:prefix
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'createRepDetails': true, // {{Boolean}} createRepDetails
  'prefix': prefix_example, // {{String}} prefix
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEntiteTypeWithCaracAndMappingFromDepot(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createEntiteTypeWithCaracAndMappingFromDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var depotId = 789;  // Long | depotId
            var createRepDetails = true;  // Boolean | createRepDetails (optional) 
            var prefix = prefix_example;  // String | prefix (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // createEntiteTypeWithCaracAndMappingFromDepot
                Long result = apiInstance.createEntiteTypeWithCaracAndMappingFromDepot(depotId, createRepDetails, prefix, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.createEntiteTypeWithCaracAndMappingFromDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$depotId = 789; // Long | depotId
$createRepDetails = true; // Boolean | createRepDetails
$prefix = prefix_example; // String | prefix
$project = 789; // Long | Project id

try {
    $result = $api_instance->createEntiteTypeWithCaracAndMappingFromDepot($depotId, $createRepDetails, $prefix, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->createEntiteTypeWithCaracAndMappingFromDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $depotId = 789; # Long | depotId
my $createRepDetails = true; # Boolean | createRepDetails
my $prefix = prefix_example; # String | prefix
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createEntiteTypeWithCaracAndMappingFromDepot(depotId => $depotId, createRepDetails => $createRepDetails, prefix => $prefix, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->createEntiteTypeWithCaracAndMappingFromDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
depotId = 789 # Long | depotId
createRepDetails = true # Boolean | createRepDetails (optional)
prefix = prefix_example # String | prefix (optional)
project = 789 # Long | Project id (optional)

try: 
    # createEntiteTypeWithCaracAndMappingFromDepot
    api_response = api_instance.create_entite_type_with_carac_and_mapping_from_depot(depotId, createRepDetails=createRepDetails, prefix=prefix, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->createEntiteTypeWithCaracAndMappingFromDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
createRepDetails
Boolean
createRepDetails
prefix
String
prefix
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editEntite

Update Entite

Update an existing Entite with a new data. This return the new Entite object


/service/entites

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entites?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntityEntry body = ; // EntityEntry | The Entite new data
        Long project = 789; // Long | Project id
        try {
            EntiteType result = apiInstance.editEntite(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#editEntite");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntityEntry body = ; // EntityEntry | The Entite new data
        Long project = 789; // Long | Project id
        try {
            EntiteType result = apiInstance.editEntite(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#editEntite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
EntityEntry *body = ; // The Entite new data (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Update Entite
[apiInstance editEntiteWith:body
    project:project
              completionHandler: ^(EntiteType output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var opts = { 
  'body':  // {{EntityEntry}} The Entite new data
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editEntite(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editEntiteExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new EntityEntry(); // EntityEntry | The Entite new data (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update Entite
                EntiteType result = apiInstance.editEntite(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.editEntite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // EntityEntry | The Entite new data
$project = 789; // Long | Project id

try {
    $result = $api_instance->editEntite($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->editEntite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = WWW::SwaggerClient::Object::EntityEntry->new(); # EntityEntry | The Entite new data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editEntite(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->editEntite: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # EntityEntry | The Entite new data (optional)
project = 789 # Long | Project id (optional)

try: 
    # Update Entite
    api_response = api_instance.edit_entite(body=body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->editEntite: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editPersistanceParams

editPersistanceParams


/service/entite_types/{entiteTypeId}/persistance_params

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_types/{entiteTypeId}/persistance_params?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        PersistanceParams body = ; // PersistanceParams | params
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPersistanceParams(body, ctx, entiteTypeId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#editPersistanceParams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        PersistanceParams body = ; // PersistanceParams | params
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPersistanceParams(body, ctx, entiteTypeId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#editPersistanceParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PersistanceParams *body = ; // params
Integer *ctx = 56; // ctx
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// editPersistanceParams
[apiInstance editPersistanceParamsWith:body
    ctx:ctx
    entiteTypeId:entiteTypeId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var body = ; // {{PersistanceParams}} params
var ctx = 56; // {{Integer}} ctx
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editPersistanceParams(bodyctxentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPersistanceParamsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new PersistanceParams(); // PersistanceParams | params
            var ctx = 56;  // Integer | ctx
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // editPersistanceParams
                apiInstance.editPersistanceParams(body, ctx, entiteTypeId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.editPersistanceParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // PersistanceParams | params
$ctx = 56; // Integer | ctx
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $api_instance->editPersistanceParams($body, $ctx, $entiteTypeId, $project);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->editPersistanceParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = WWW::SwaggerClient::Object::PersistanceParams->new(); # PersistanceParams | params
my $ctx = 56; # Integer | ctx
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    $api_instance->editPersistanceParams(body => $body, ctx => $ctx, entiteTypeId => $entiteTypeId, project => $project);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->editPersistanceParams: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # PersistanceParams | params
ctx = 56 # Integer | ctx
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # editPersistanceParams
    api_instance.edit_persistance_params(body, ctx, entiteTypeId, project=project)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->editPersistanceParams: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findNbrEntites

findNbrEntites


/service/entite_types/{entiteTypeId}/entites_nbr

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/entites_nbr?ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            ExecDataResult result = apiInstance.findNbrEntites(ctx, entiteTypeId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#findNbrEntites");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            ExecDataResult result = apiInstance.findNbrEntites(ctx, entiteTypeId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#findNbrEntites");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// findNbrEntites
[apiInstance findNbrEntitesWith:ctx
    entiteTypeId:entiteTypeId
    project:project
    useCache:useCache
              completionHandler: ^(ExecDataResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var ctx = 56; // {{Integer}} ctx
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findNbrEntites(ctx, entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findNbrEntitesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var ctx = 56;  // Integer | ctx
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // findNbrEntites
                ExecDataResult result = apiInstance.findNbrEntites(ctx, entiteTypeId, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.findNbrEntites: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$ctx = 56; // Integer | ctx
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->findNbrEntites($ctx, $entiteTypeId, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->findNbrEntites: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $ctx = 56; # Integer | ctx
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->findNbrEntites(ctx => $ctx, entiteTypeId => $entiteTypeId, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->findNbrEntites: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
ctx = 56 # Integer | ctx
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # findNbrEntites
    api_response = api_instance.find_nbr_entites(ctx, entiteTypeId, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->findNbrEntites: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findNbrValuesPerCarac

findNbrValuesPerCarac


/service/entite_types/{entiteTypeId}/values_nbr

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/values_nbr?ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            ExecDataResult result = apiInstance.findNbrValuesPerCarac(ctx, entiteTypeId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#findNbrValuesPerCarac");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            ExecDataResult result = apiInstance.findNbrValuesPerCarac(ctx, entiteTypeId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#findNbrValuesPerCarac");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// findNbrValuesPerCarac
[apiInstance findNbrValuesPerCaracWith:ctx
    entiteTypeId:entiteTypeId
    project:project
    useCache:useCache
              completionHandler: ^(ExecDataResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var ctx = 56; // {{Integer}} ctx
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findNbrValuesPerCarac(ctx, entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findNbrValuesPerCaracExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var ctx = 56;  // Integer | ctx
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // findNbrValuesPerCarac
                ExecDataResult result = apiInstance.findNbrValuesPerCarac(ctx, entiteTypeId, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.findNbrValuesPerCarac: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$ctx = 56; // Integer | ctx
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->findNbrValuesPerCarac($ctx, $entiteTypeId, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->findNbrValuesPerCarac: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $ctx = 56; # Integer | ctx
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->findNbrValuesPerCarac(ctx => $ctx, entiteTypeId => $entiteTypeId, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->findNbrValuesPerCarac: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
ctx = 56 # Integer | ctx
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # findNbrValuesPerCarac
    api_response = api_instance.find_nbr_values_per_carac(ctx, entiteTypeId, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->findNbrValuesPerCarac: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getAllEntites

Get all Entites

Get all Entites


/service/entites

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entites?exclude=&excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long exclude = 789; // Long | Excluded Entite id
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[EntiteType] result = apiInstance.getAllEntites(exclude, excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getAllEntites");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long exclude = 789; // Long | Excluded Entite id
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[EntiteType] result = apiInstance.getAllEntites(exclude, excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getAllEntites");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *exclude = 789; // Excluded Entite id (optional)
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Get all Entites
[apiInstance getAllEntitesWith:exclude
    excludeInactive:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[EntiteType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var opts = { 
  'exclude': 789, // {{Long}} Excluded Entite id
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllEntites(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllEntitesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var exclude = 789;  // Long | Excluded Entite id (optional) 
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get all Entites
                array[EntiteType] result = apiInstance.getAllEntites(exclude, excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getAllEntites: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$exclude = 789; // Long | Excluded Entite id
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllEntites($exclude, $excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getAllEntites: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $exclude = 789; # Long | Excluded Entite id
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllEntites(exclude => $exclude, excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getAllEntites: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
exclude = 789 # Long | Excluded Entite id (optional)
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get all Entites
    api_response = api_instance.get_all_entites(exclude=exclude, excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getAllEntites: %s\n" % e)

Parameters

Query parameters
Name Description
exclude
Long (int64)
Excluded Entite id
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCaracTopValues

getCaracTopValues


/service/entite_types/{entiteTypeId}/top_values/{caracId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/top_values/{caracId}?clientId=&ctx=&limit=&order=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long caracId = 789; // Long | caracId
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer limit = 56; // Integer | limit
        String order = order_example; // String | order
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getCaracTopValues(caracId, clientId, entiteTypeId, limit, order, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getCaracTopValues");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long caracId = 789; // Long | caracId
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer limit = 56; // Integer | limit
        String order = order_example; // String | order
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getCaracTopValues(caracId, clientId, entiteTypeId, limit, order, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getCaracTopValues");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *caracId = 789; // caracId
String *clientId = clientId_example; // clientId
Long *entiteTypeId = 789; // entiteTypeId
Integer *limit = 56; // limit
String *order = order_example; // order
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getCaracTopValues
[apiInstance getCaracTopValuesWith:caracId
    clientId:clientId
    entiteTypeId:entiteTypeId
    limit:limit
    order:order
    ctx:ctx
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var caracId = 789; // {{Long}} caracId
var clientId = clientId_example; // {{String}} clientId
var entiteTypeId = 789; // {{Long}} entiteTypeId
var limit = 56; // {{Integer}} limit
var order = order_example; // {{String}} order
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaracTopValues(caracId, clientId, entiteTypeId, limit, order, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaracTopValuesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var caracId = 789;  // Long | caracId
            var clientId = clientId_example;  // String | clientId
            var entiteTypeId = 789;  // Long | entiteTypeId
            var limit = 56;  // Integer | limit
            var order = order_example;  // String | order
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getCaracTopValues
                JobKeyResponse result = apiInstance.getCaracTopValues(caracId, clientId, entiteTypeId, limit, order, ctx, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getCaracTopValues: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$caracId = 789; // Long | caracId
$clientId = clientId_example; // String | clientId
$entiteTypeId = 789; // Long | entiteTypeId
$limit = 56; // Integer | limit
$order = order_example; // String | order
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getCaracTopValues($caracId, $clientId, $entiteTypeId, $limit, $order, $ctx, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getCaracTopValues: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $caracId = 789; # Long | caracId
my $clientId = clientId_example; # String | clientId
my $entiteTypeId = 789; # Long | entiteTypeId
my $limit = 56; # Integer | limit
my $order = order_example; # String | order
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getCaracTopValues(caracId => $caracId, clientId => $clientId, entiteTypeId => $entiteTypeId, limit => $limit, order => $order, ctx => $ctx, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getCaracTopValues: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
caracId = 789 # Long | caracId
clientId = clientId_example # String | clientId
entiteTypeId = 789 # Long | entiteTypeId
limit = 56 # Integer | limit
order = order_example # String | order
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getCaracTopValues
    api_response = api_instance.get_carac_top_values(caracId, clientId, entiteTypeId, limit, order, ctx=ctx, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getCaracTopValues: %s\n" % e)

Parameters

Path parameters
Name Description
caracId*
Long (int64)
caracId
Required
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
clientId*
String
clientId
Required
ctx
Integer (int32)
ctx
limit*
Integer (int32)
limit
Required
order*
String
order
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getColumnsFromCaracs

getColumnsFromCaracs


/service/entite_types/{entiteTypeId}/columns

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/columns?excludeLinks=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Boolean excludeLinks = true; // Boolean | excludeLinks
        Long project = 789; // Long | Project id
        try {
            array[DBBuilderColumn] result = apiInstance.getColumnsFromCaracs(entiteTypeId, excludeLinks, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getColumnsFromCaracs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Boolean excludeLinks = true; // Boolean | excludeLinks
        Long project = 789; // Long | Project id
        try {
            array[DBBuilderColumn] result = apiInstance.getColumnsFromCaracs(entiteTypeId, excludeLinks, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getColumnsFromCaracs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteTypeId = 789; // entiteTypeId
Boolean *excludeLinks = true; // excludeLinks (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getColumnsFromCaracs
[apiInstance getColumnsFromCaracsWith:entiteTypeId
    excludeLinks:excludeLinks
    project:project
              completionHandler: ^(array[DBBuilderColumn] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'excludeLinks': true, // {{Boolean}} excludeLinks
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getColumnsFromCaracs(entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getColumnsFromCaracsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var entiteTypeId = 789;  // Long | entiteTypeId
            var excludeLinks = true;  // Boolean | excludeLinks (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getColumnsFromCaracs
                array[DBBuilderColumn] result = apiInstance.getColumnsFromCaracs(entiteTypeId, excludeLinks, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getColumnsFromCaracs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$entiteTypeId = 789; // Long | entiteTypeId
$excludeLinks = true; // Boolean | excludeLinks
$project = 789; // Long | Project id

try {
    $result = $api_instance->getColumnsFromCaracs($entiteTypeId, $excludeLinks, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getColumnsFromCaracs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $entiteTypeId = 789; # Long | entiteTypeId
my $excludeLinks = true; # Boolean | excludeLinks
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getColumnsFromCaracs(entiteTypeId => $entiteTypeId, excludeLinks => $excludeLinks, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getColumnsFromCaracs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
entiteTypeId = 789 # Long | entiteTypeId
excludeLinks = true # Boolean | excludeLinks (optional)
project = 789 # Long | Project id (optional)

try: 
    # getColumnsFromCaracs
    api_response = api_instance.get_columns_from_caracs(entiteTypeId, excludeLinks=excludeLinks, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getColumnsFromCaracs: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
excludeLinks
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlocksUsing

getDataBlocksUsing


/service/entite_types/{entiteTypeId}/datablocks

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/datablocks?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            array[DataBlock] result = apiInstance.getDataBlocksUsing(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getDataBlocksUsing");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            array[DataBlock] result = apiInstance.getDataBlocksUsing(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getDataBlocksUsing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getDataBlocksUsing
[apiInstance getDataBlocksUsingWith:entiteTypeId
    project:project
              completionHandler: ^(array[DataBlock] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlocksUsing(entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlocksUsingExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getDataBlocksUsing
                array[DataBlock] result = apiInstance.getDataBlocksUsing(entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getDataBlocksUsing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getDataBlocksUsing($entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getDataBlocksUsing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDataBlocksUsing(entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getDataBlocksUsing: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # getDataBlocksUsing
    api_response = api_instance.get_data_blocks_using(entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getDataBlocksUsing: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntite

Get Entite by Id

Get Entite by id


/service/entites/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entites/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long id = 789; // Long | The id of the requested Entite
        Long project = 789; // Long | Project id
        try {
            EntiteType result = apiInstance.getEntite(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntite");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long id = 789; // Long | The id of the requested Entite
        Long project = 789; // Long | Project id
        try {
            EntiteType result = apiInstance.getEntite(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The id of the requested Entite
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Get Entite by Id
[apiInstance getEntiteWith:id
    project:project
              completionHandler: ^(EntiteType output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var id = 789; // {{Long}} The id of the requested Entite
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntite(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var id = 789;  // Long | The id of the requested Entite
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get Entite by Id
                EntiteType result = apiInstance.getEntite(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$id = 789; // Long | The id of the requested Entite
$project = 789; // Long | Project id

try {
    $result = $api_instance->getEntite($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $id = 789; # Long | The id of the requested Entite
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getEntite(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntite: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
id = 789 # Long | The id of the requested Entite
project = 789 # Long | Project id (optional)

try: 
    # Get Entite by Id
    api_response = api_instance.get_entite(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntite: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The id of the requested Entite
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteCaracCount

Get carac count by Entite id


/service/entites/{id}/carac_count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entites/{id}/carac_count?isSimple=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long id = 789; // Long | The Entite id
        Boolean isSimple = true; // Boolean | isSimple
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getEntiteCaracCount(id, isSimple, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteCaracCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long id = 789; // Long | The Entite id
        Boolean isSimple = true; // Boolean | isSimple
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getEntiteCaracCount(id, isSimple, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteCaracCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Entite id
Boolean *isSimple = true; // isSimple (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Get carac count by Entite id
[apiInstance getEntiteCaracCountWith:id
    isSimple:isSimple
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var id = 789; // {{Long}} The Entite id
var opts = { 
  'isSimple': true, // {{Boolean}} isSimple
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteCaracCount(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteCaracCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var id = 789;  // Long | The Entite id
            var isSimple = true;  // Boolean | isSimple (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get carac count by Entite id
                Long result = apiInstance.getEntiteCaracCount(id, isSimple, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteCaracCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$id = 789; // Long | The Entite id
$isSimple = true; // Boolean | isSimple
$project = 789; // Long | Project id

try {
    $result = $api_instance->getEntiteCaracCount($id, $isSimple, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteCaracCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $id = 789; # Long | The Entite id
my $isSimple = true; # Boolean | isSimple
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getEntiteCaracCount(id => $id, isSimple => $isSimple, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteCaracCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
id = 789 # Long | The Entite id
isSimple = true # Boolean | isSimple (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get carac count by Entite id
    api_response = api_instance.get_entite_carac_count(id, isSimple=isSimple, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteCaracCount: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Entite id
Required
Query parameters
Name Description
isSimple
Boolean
isSimple
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteCaracs

Get all caracs by Entite id


/service/entites/{id}/caracs

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entites/{id}/caracs?isSimple=&project=&withTags="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long id = 789; // Long | The Entite id
        Boolean isSimple = true; // Boolean | isSimple
        Long project = 789; // Long | Project id
        Boolean withTags = true; // Boolean | withTags
        try {
            array[Carac] result = apiInstance.getEntiteCaracs(id, isSimple, project, withTags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteCaracs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long id = 789; // Long | The Entite id
        Boolean isSimple = true; // Boolean | isSimple
        Long project = 789; // Long | Project id
        Boolean withTags = true; // Boolean | withTags
        try {
            array[Carac] result = apiInstance.getEntiteCaracs(id, isSimple, project, withTags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteCaracs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Entite id
Boolean *isSimple = true; // isSimple (optional)
Long *project = 789; // Project id (optional)
Boolean *withTags = true; // withTags (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Get all caracs by Entite id
[apiInstance getEntiteCaracsWith:id
    isSimple:isSimple
    project:project
    withTags:withTags
              completionHandler: ^(array[Carac] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var id = 789; // {{Long}} The Entite id
var opts = { 
  'isSimple': true, // {{Boolean}} isSimple
  'project': 789, // {{Long}} Project id
  'withTags': true // {{Boolean}} withTags
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteCaracs(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteCaracsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var id = 789;  // Long | The Entite id
            var isSimple = true;  // Boolean | isSimple (optional) 
            var project = 789;  // Long | Project id (optional) 
            var withTags = true;  // Boolean | withTags (optional) 

            try
            {
                // Get all caracs by Entite id
                array[Carac] result = apiInstance.getEntiteCaracs(id, isSimple, project, withTags);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteCaracs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$id = 789; // Long | The Entite id
$isSimple = true; // Boolean | isSimple
$project = 789; // Long | Project id
$withTags = true; // Boolean | withTags

try {
    $result = $api_instance->getEntiteCaracs($id, $isSimple, $project, $withTags);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteCaracs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $id = 789; # Long | The Entite id
my $isSimple = true; # Boolean | isSimple
my $project = 789; # Long | Project id
my $withTags = true; # Boolean | withTags

eval { 
    my $result = $api_instance->getEntiteCaracs(id => $id, isSimple => $isSimple, project => $project, withTags => $withTags);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteCaracs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
id = 789 # Long | The Entite id
isSimple = true # Boolean | isSimple (optional)
project = 789 # Long | Project id (optional)
withTags = true # Boolean | withTags (optional)

try: 
    # Get all caracs by Entite id
    api_response = api_instance.get_entite_caracs(id, isSimple=isSimple, project=project, withTags=withTags)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteCaracs: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Entite id
Required
Query parameters
Name Description
isSimple
Boolean
isSimple
project
Long (int64)
Project id
withTags
Boolean
withTags

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntitePersistanceParams

getPersistanceParams


/service/entite_types/{entiteTypeId}/persistance_params

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/persistance_params?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            PersistanceParams result = apiInstance.getEntitePersistanceParams(ctx, entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntitePersistanceParams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            PersistanceParams result = apiInstance.getEntitePersistanceParams(ctx, entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntitePersistanceParams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getPersistanceParams
[apiInstance getEntitePersistanceParamsWith:ctx
    entiteTypeId:entiteTypeId
    project:project
              completionHandler: ^(PersistanceParams output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var ctx = 56; // {{Integer}} ctx
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntitePersistanceParams(ctx, entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntitePersistanceParamsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var ctx = 56;  // Integer | ctx
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getPersistanceParams
                PersistanceParams result = apiInstance.getEntitePersistanceParams(ctx, entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntitePersistanceParams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$ctx = 56; // Integer | ctx
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getEntitePersistanceParams($ctx, $entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntitePersistanceParams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $ctx = 56; # Integer | ctx
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getEntitePersistanceParams(ctx => $ctx, entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntitePersistanceParams: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
ctx = 56 # Integer | ctx
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # getPersistanceParams
    api_response = api_instance.get_entite_persistance_params(ctx, entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntitePersistanceParams: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteTypeCountAll

getEntiteTypeCountAll


/service/entite_types/{entiteTypeId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/count?clientId=&ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeCountAll(clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeCountAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeCountAll(clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeCountAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *clientId = clientId_example; // clientId
Long *entiteTypeId = 789; // entiteTypeId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getEntiteTypeCountAll
[apiInstance getEntiteTypeCountAllWith:clientId
    entiteTypeId:entiteTypeId
    ctx:ctx
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var clientId = clientId_example; // {{String}} clientId
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteTypeCountAll(clientId, entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteTypeCountAllExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var clientId = clientId_example;  // String | clientId
            var entiteTypeId = 789;  // Long | entiteTypeId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getEntiteTypeCountAll
                JobKeyResponse result = apiInstance.getEntiteTypeCountAll(clientId, entiteTypeId, ctx, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteTypeCountAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$clientId = clientId_example; // String | clientId
$entiteTypeId = 789; // Long | entiteTypeId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getEntiteTypeCountAll($clientId, $entiteTypeId, $ctx, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteTypeCountAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $clientId = clientId_example; # String | clientId
my $entiteTypeId = 789; # Long | entiteTypeId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getEntiteTypeCountAll(clientId => $clientId, entiteTypeId => $entiteTypeId, ctx => $ctx, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteTypeCountAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
clientId = clientId_example # String | clientId
entiteTypeId = 789 # Long | entiteTypeId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getEntiteTypeCountAll
    api_response = api_instance.get_entite_type_count_all(clientId, entiteTypeId, ctx=ctx, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteTypeCountAll: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
clientId*
String
clientId
Required
ctx
Integer (int32)
ctx
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteTypeGrammar

get EntiteType Grammar


/service/entite_types/{entiteTypeId}/grammar

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/grammar?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            BaseRequestGrammar result = apiInstance.getEntiteTypeGrammar(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeGrammar");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            BaseRequestGrammar result = apiInstance.getEntiteTypeGrammar(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeGrammar");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// get EntiteType Grammar
[apiInstance getEntiteTypeGrammarWith:entiteTypeId
    project:project
              completionHandler: ^(BaseRequestGrammar output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteTypeGrammar(entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteTypeGrammarExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get EntiteType Grammar
                BaseRequestGrammar result = apiInstance.getEntiteTypeGrammar(entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteTypeGrammar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getEntiteTypeGrammar($entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteTypeGrammar: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getEntiteTypeGrammar(entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteTypeGrammar: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # get EntiteType Grammar
    api_response = api_instance.get_entite_type_grammar(entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteTypeGrammar: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteTypeStatsByJobKey

getEntiteTypeStatsByJobKey


/service/entite_types/stat_job_result

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/stat_job_result?ctx=&jobKey=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        String jobKey = jobKey_example; // String | jobKey
        Long project = 789; // Long | Project id
        try {
            ExecDataResult result = apiInstance.getEntiteTypeStatsByJobKey(ctx, jobKey, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeStatsByJobKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Integer ctx = 56; // Integer | ctx
        String jobKey = jobKey_example; // String | jobKey
        Long project = 789; // Long | Project id
        try {
            ExecDataResult result = apiInstance.getEntiteTypeStatsByJobKey(ctx, jobKey, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeStatsByJobKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *jobKey = jobKey_example; // jobKey
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getEntiteTypeStatsByJobKey
[apiInstance getEntiteTypeStatsByJobKeyWith:ctx
    jobKey:jobKey
    project:project
              completionHandler: ^(ExecDataResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var ctx = 56; // {{Integer}} ctx
var jobKey = jobKey_example; // {{String}} jobKey
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteTypeStatsByJobKey(ctx, jobKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteTypeStatsByJobKeyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var ctx = 56;  // Integer | ctx
            var jobKey = jobKey_example;  // String | jobKey
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getEntiteTypeStatsByJobKey
                ExecDataResult result = apiInstance.getEntiteTypeStatsByJobKey(ctx, jobKey, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteTypeStatsByJobKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$ctx = 56; // Integer | ctx
$jobKey = jobKey_example; // String | jobKey
$project = 789; // Long | Project id

try {
    $result = $api_instance->getEntiteTypeStatsByJobKey($ctx, $jobKey, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteTypeStatsByJobKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $ctx = 56; # Integer | ctx
my $jobKey = jobKey_example; # String | jobKey
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getEntiteTypeStatsByJobKey(ctx => $ctx, jobKey => $jobKey, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteTypeStatsByJobKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
ctx = 56 # Integer | ctx
jobKey = jobKey_example # String | jobKey
project = 789 # Long | Project id (optional)

try: 
    # getEntiteTypeStatsByJobKey
    api_response = api_instance.get_entite_type_stats_by_job_key(ctx, jobKey, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteTypeStatsByJobKey: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
jobKey*
String
jobKey
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteTypeValuesCount

getEntiteTypeValuesCount


/service/entite_types/{entiteTypeId}/values_count

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_types/{entiteTypeId}/values_count?clientId=&ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        array[EntiteTypeCaraFormula] body = ; // array[EntiteTypeCaraFormula] | caracs
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeValuesCount(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeValuesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        array[EntiteTypeCaraFormula] body = ; // array[EntiteTypeCaraFormula] | caracs
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeValuesCount(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeValuesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[EntiteTypeCaraFormula] *body = ; // caracs
String *clientId = clientId_example; // clientId
Long *entiteTypeId = 789; // entiteTypeId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getEntiteTypeValuesCount
[apiInstance getEntiteTypeValuesCountWith:body
    clientId:clientId
    entiteTypeId:entiteTypeId
    ctx:ctx
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var body = ; // {{array[EntiteTypeCaraFormula]}} caracs
var clientId = clientId_example; // {{String}} clientId
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteTypeValuesCount(bodyclientIdentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteTypeValuesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new array[EntiteTypeCaraFormula](); // array[EntiteTypeCaraFormula] | caracs
            var clientId = clientId_example;  // String | clientId
            var entiteTypeId = 789;  // Long | entiteTypeId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getEntiteTypeValuesCount
                JobKeyResponse result = apiInstance.getEntiteTypeValuesCount(body, clientId, entiteTypeId, ctx, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteTypeValuesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // array[EntiteTypeCaraFormula] | caracs
$clientId = clientId_example; // String | clientId
$entiteTypeId = 789; // Long | entiteTypeId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getEntiteTypeValuesCount($body, $clientId, $entiteTypeId, $ctx, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[EntiteTypeCaraFormula]->new()]; # array[EntiteTypeCaraFormula] | caracs
my $clientId = clientId_example; # String | clientId
my $entiteTypeId = 789; # Long | entiteTypeId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getEntiteTypeValuesCount(body => $body, clientId => $clientId, entiteTypeId => $entiteTypeId, ctx => $ctx, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # array[EntiteTypeCaraFormula] | caracs
clientId = clientId_example # String | clientId
entiteTypeId = 789 # Long | entiteTypeId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getEntiteTypeValuesCount
    api_response = api_instance.get_entite_type_values_count(body, clientId, entiteTypeId, ctx=ctx, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesCount: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
clientId*
String
clientId
Required
ctx
Integer (int32)
ctx
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteTypeValuesCountDistinct

getEntiteTypeValuesCountDistinct


/service/entite_types/{entiteTypeId}/values_count_distinct

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_types/{entiteTypeId}/values_count_distinct?clientId=&ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        array[EntiteTypeCaraFormula] body = ; // array[EntiteTypeCaraFormula] | caracs
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeValuesCountDistinct(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeValuesCountDistinct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        array[EntiteTypeCaraFormula] body = ; // array[EntiteTypeCaraFormula] | caracs
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeValuesCountDistinct(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeValuesCountDistinct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[EntiteTypeCaraFormula] *body = ; // caracs
String *clientId = clientId_example; // clientId
Long *entiteTypeId = 789; // entiteTypeId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getEntiteTypeValuesCountDistinct
[apiInstance getEntiteTypeValuesCountDistinctWith:body
    clientId:clientId
    entiteTypeId:entiteTypeId
    ctx:ctx
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var body = ; // {{array[EntiteTypeCaraFormula]}} caracs
var clientId = clientId_example; // {{String}} clientId
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteTypeValuesCountDistinct(bodyclientIdentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteTypeValuesCountDistinctExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new array[EntiteTypeCaraFormula](); // array[EntiteTypeCaraFormula] | caracs
            var clientId = clientId_example;  // String | clientId
            var entiteTypeId = 789;  // Long | entiteTypeId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getEntiteTypeValuesCountDistinct
                JobKeyResponse result = apiInstance.getEntiteTypeValuesCountDistinct(body, clientId, entiteTypeId, ctx, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteTypeValuesCountDistinct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // array[EntiteTypeCaraFormula] | caracs
$clientId = clientId_example; // String | clientId
$entiteTypeId = 789; // Long | entiteTypeId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getEntiteTypeValuesCountDistinct($body, $clientId, $entiteTypeId, $ctx, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesCountDistinct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[EntiteTypeCaraFormula]->new()]; # array[EntiteTypeCaraFormula] | caracs
my $clientId = clientId_example; # String | clientId
my $entiteTypeId = 789; # Long | entiteTypeId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getEntiteTypeValuesCountDistinct(body => $body, clientId => $clientId, entiteTypeId => $entiteTypeId, ctx => $ctx, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesCountDistinct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # array[EntiteTypeCaraFormula] | caracs
clientId = clientId_example # String | clientId
entiteTypeId = 789 # Long | entiteTypeId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getEntiteTypeValuesCountDistinct
    api_response = api_instance.get_entite_type_values_count_distinct(body, clientId, entiteTypeId, ctx=ctx, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesCountDistinct: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
clientId*
String
clientId
Required
ctx
Integer (int32)
ctx
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntiteTypeValuesStat

getEntiteTypeValuesStat


/service/entite_types/{entiteTypeId}/values_stat

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_types/{entiteTypeId}/values_stat?clientId=&ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntiteTypeCaraFormula body = ; // EntiteTypeCaraFormula | carac
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeValuesStat(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeValuesStat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntiteTypeCaraFormula body = ; // EntiteTypeCaraFormula | carac
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getEntiteTypeValuesStat(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntiteTypeValuesStat");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
EntiteTypeCaraFormula *body = ; // carac
String *clientId = clientId_example; // clientId
Long *entiteTypeId = 789; // entiteTypeId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getEntiteTypeValuesStat
[apiInstance getEntiteTypeValuesStatWith:body
    clientId:clientId
    entiteTypeId:entiteTypeId
    ctx:ctx
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var body = ; // {{EntiteTypeCaraFormula}} carac
var clientId = clientId_example; // {{String}} clientId
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteTypeValuesStat(bodyclientIdentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteTypeValuesStatExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new EntiteTypeCaraFormula(); // EntiteTypeCaraFormula | carac
            var clientId = clientId_example;  // String | clientId
            var entiteTypeId = 789;  // Long | entiteTypeId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getEntiteTypeValuesStat
                JobKeyResponse result = apiInstance.getEntiteTypeValuesStat(body, clientId, entiteTypeId, ctx, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntiteTypeValuesStat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // EntiteTypeCaraFormula | carac
$clientId = clientId_example; // String | clientId
$entiteTypeId = 789; // Long | entiteTypeId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getEntiteTypeValuesStat($body, $clientId, $entiteTypeId, $ctx, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesStat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = WWW::SwaggerClient::Object::EntiteTypeCaraFormula->new(); # EntiteTypeCaraFormula | carac
my $clientId = clientId_example; # String | clientId
my $entiteTypeId = 789; # Long | entiteTypeId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getEntiteTypeValuesStat(body => $body, clientId => $clientId, entiteTypeId => $entiteTypeId, ctx => $ctx, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesStat: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # EntiteTypeCaraFormula | carac
clientId = clientId_example # String | clientId
entiteTypeId = 789 # Long | entiteTypeId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getEntiteTypeValuesStat
    api_response = api_instance.get_entite_type_values_stat(body, clientId, entiteTypeId, ctx=ctx, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntiteTypeValuesStat: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
clientId*
String
clientId
Required
ctx
Integer (int32)
ctx
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getEntityElementsForMove

Get entities linked element for move/copy


/service/entite_types/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Entite Type ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getEntityElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntityElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Entite Type ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getEntityElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getEntityElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Entite Type ID (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Get entities linked element for move/copy
[apiInstance getEntityElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Entite Type ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntityElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntityElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Entite Type ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get entities linked element for move/copy
                array[DcUsedElement] result = apiInstance.getEntityElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getEntityElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Entite Type ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getEntityElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getEntityElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Entite Type ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getEntityElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getEntityElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Entite Type ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get entities linked element for move/copy
    api_response = api_instance.get_entity_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getEntityElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Entite Type ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getLinksCount

getLinksCount


/service/entite_types/{entiteTypeId}/links/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/{entiteTypeId}/links/count?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getLinksCount(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getLinksCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getLinksCount(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getLinksCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getLinksCount
[apiInstance getLinksCountWith:entiteTypeId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLinksCount(entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLinksCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getLinksCount
                Long result = apiInstance.getLinksCount(entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getLinksCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getLinksCount($entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getLinksCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getLinksCount(entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getLinksCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # getLinksCount
    api_response = api_instance.get_links_count(entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getLinksCount: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getLinksCountByCaracId

getLinksCountByCaracId


/service/entite_types/links/count/{caracId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/links/count/{caracId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getLinksCountByCaracId(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getLinksCountByCaracId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getLinksCountByCaracId(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getLinksCountByCaracId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *caracId = 789; // caracId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getLinksCountByCaracId
[apiInstance getLinksCountByCaracIdWith:caracId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var caracId = 789; // {{Long}} caracId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLinksCountByCaracId(caracId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLinksCountByCaracIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var caracId = 789;  // Long | caracId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getLinksCountByCaracId
                Long result = apiInstance.getLinksCountByCaracId(caracId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getLinksCountByCaracId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$caracId = 789; // Long | caracId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getLinksCountByCaracId($caracId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getLinksCountByCaracId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $caracId = 789; # Long | caracId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getLinksCountByCaracId(caracId => $caracId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getLinksCountByCaracId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
caracId = 789 # Long | caracId
project = 789 # Long | Project id (optional)

try: 
    # getLinksCountByCaracId
    api_response = api_instance.get_links_count_by_carac_id(caracId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getLinksCountByCaracId: %s\n" % e)

Parameters

Path parameters
Name Description
caracId*
Long (int64)
caracId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMappingCountByCaracId

getMappingCountByCaracId


/service/entite_types/caracs/count/{caracId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/caracs/count/{caracId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getMappingCountByCaracId(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getMappingCountByCaracId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getMappingCountByCaracId(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getMappingCountByCaracId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *caracId = 789; // caracId
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getMappingCountByCaracId
[apiInstance getMappingCountByCaracIdWith:caracId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var caracId = 789; // {{Long}} caracId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMappingCountByCaracId(caracId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMappingCountByCaracIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var caracId = 789;  // Long | caracId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getMappingCountByCaracId
                Long result = apiInstance.getMappingCountByCaracId(caracId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getMappingCountByCaracId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$caracId = 789; // Long | caracId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMappingCountByCaracId($caracId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getMappingCountByCaracId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $caracId = 789; # Long | caracId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMappingCountByCaracId(caracId => $caracId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getMappingCountByCaracId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
caracId = 789 # Long | caracId
project = 789 # Long | Project id (optional)

try: 
    # getMappingCountByCaracId
    api_response = api_instance.get_mapping_count_by_carac_id(caracId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getMappingCountByCaracId: %s\n" % e)

Parameters

Path parameters
Name Description
caracId*
Long (int64)
caracId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getSimpleTypes

getSimpleTypes


/service/simple_types

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/simple_types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        try {
            array[EntiteType] result = apiInstance.getSimpleTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getSimpleTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        try {
            array[EntiteType] result = apiInstance.getSimpleTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getSimpleTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getSimpleTypes
[apiInstance getSimpleTypesWithCompletionHandler: 
              ^(array[EntiteType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSimpleTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSimpleTypesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();

            try
            {
                // getSimpleTypes
                array[EntiteType] result = apiInstance.getSimpleTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getSimpleTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();

try {
    $result = $api_instance->getSimpleTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getSimpleTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();

eval { 
    my $result = $api_instance->getSimpleTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getSimpleTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()

try: 
    # getSimpleTypes
    api_response = api_instance.get_simple_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getSimpleTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getStatFunctionValues

getStatFunctionValues


/service/entite_types/{entiteTypeId}/stat

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_types/{entiteTypeId}/stat?clientId=&ctx=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntiteTypeCaraFormula body = ; // EntiteTypeCaraFormula | var
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getStatFunctionValues(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getStatFunctionValues");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        EntiteTypeCaraFormula body = ; // EntiteTypeCaraFormula | var
        String clientId = clientId_example; // String | clientId
        Long entiteTypeId = 789; // Long | entiteTypeId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.getStatFunctionValues(body, clientId, entiteTypeId, ctx, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getStatFunctionValues");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
EntiteTypeCaraFormula *body = ; // var
String *clientId = clientId_example; // clientId
Long *entiteTypeId = 789; // entiteTypeId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getStatFunctionValues
[apiInstance getStatFunctionValuesWith:body
    clientId:clientId
    entiteTypeId:entiteTypeId
    ctx:ctx
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var body = ; // {{EntiteTypeCaraFormula}} var
var clientId = clientId_example; // {{String}} clientId
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatFunctionValues(bodyclientIdentiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStatFunctionValuesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new EntiteTypeCaraFormula(); // EntiteTypeCaraFormula | var
            var clientId = clientId_example;  // String | clientId
            var entiteTypeId = 789;  // Long | entiteTypeId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // getStatFunctionValues
                JobKeyResponse result = apiInstance.getStatFunctionValues(body, clientId, entiteTypeId, ctx, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getStatFunctionValues: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // EntiteTypeCaraFormula | var
$clientId = clientId_example; // String | clientId
$entiteTypeId = 789; // Long | entiteTypeId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getStatFunctionValues($body, $clientId, $entiteTypeId, $ctx, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getStatFunctionValues: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = WWW::SwaggerClient::Object::EntiteTypeCaraFormula->new(); # EntiteTypeCaraFormula | var
my $clientId = clientId_example; # String | clientId
my $entiteTypeId = 789; # Long | entiteTypeId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getStatFunctionValues(body => $body, clientId => $clientId, entiteTypeId => $entiteTypeId, ctx => $ctx, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getStatFunctionValues: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # EntiteTypeCaraFormula | var
clientId = clientId_example # String | clientId
entiteTypeId = 789 # Long | entiteTypeId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # getStatFunctionValues
    api_response = api_instance.get_stat_function_values(body, clientId, entiteTypeId, ctx=ctx, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getStatFunctionValues: %s\n" % e)

Parameters

Path parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
clientId*
String
clientId
Required
ctx
Integer (int32)
ctx
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getUetsCodes

getUetsCodes


/service/entite_types/codes

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/entite_types/codes?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        array[Long] body = ; // array[Long] | uetIds
        Long project = 789; // Long | Project id
        try {
            map['String', 'String'] result = apiInstance.getUetsCodes(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getUetsCodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        array[Long] body = ; // array[Long] | uetIds
        Long project = 789; // Long | Project id
        try {
            map['String', 'String'] result = apiInstance.getUetsCodes(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#getUetsCodes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *body = ; // uetIds
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// getUetsCodes
[apiInstance getUetsCodesWith:body
    project:project
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var body = ; // {{array[Long]}} uetIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUetsCodes(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUetsCodesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var body = new array[Long](); // array[Long] | uetIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getUetsCodes
                map['String', 'String'] result = apiInstance.getUetsCodes(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.getUetsCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$body = ; // array[Long] | uetIds
$project = 789; // Long | Project id

try {
    $result = $api_instance->getUetsCodes($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->getUetsCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[Long]->new()]; # array[Long] | uetIds
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getUetsCodes(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->getUetsCodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
body =  # array[Long] | uetIds
project = 789 # Long | Project id (optional)

try: 
    # getUetsCodes
    api_response = api_instance.get_uets_codes(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->getUetsCodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveEntityElements

Move Entity and linked elements to another project


/service/entite_types/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Entite Type ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveEntityElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#moveEntityElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Entite Type ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveEntityElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#moveEntityElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Entite Type ID (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Move Entity and linked elements to another project
[apiInstance moveEntityElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Entite Type ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveEntityElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveEntityElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Entite Type ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move Entity and linked elements to another project
                DcMoveResponse result = apiInstance.moveEntityElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.moveEntityElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Entite Type ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveEntityElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->moveEntityElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Entite Type ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveEntityElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->moveEntityElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Entite Type ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move Entity and linked elements to another project
    api_response = api_instance.move_entity_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->moveEntityElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Entite Type ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


searchEntites

Search EntiteTypes


/service/entite_types/search

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_types/search?excludeType=&libCourt=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long excludeType = 789; // Long | excludeType
        String libCourt = libCourt_example; // String | libCourt
        Long project = 789; // Long | Project id
        try {
            array[EntiteType] result = apiInstance.searchEntites(excludeType, libCourt, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#searchEntites");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeControllerApi;

public class EntiteTypeControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeControllerApi apiInstance = new EntiteTypeControllerApi();
        Long excludeType = 789; // Long | excludeType
        String libCourt = libCourt_example; // String | libCourt
        Long project = 789; // Long | Project id
        try {
            array[EntiteType] result = apiInstance.searchEntites(excludeType, libCourt, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeControllerApi#searchEntites");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *excludeType = 789; // excludeType (optional)
String *libCourt = libCourt_example; // libCourt (optional)
Long *project = 789; // Project id (optional)

EntiteTypeControllerApi *apiInstance = [[EntiteTypeControllerApi alloc] init];

// Search EntiteTypes
[apiInstance searchEntitesWith:excludeType
    libCourt:libCourt
    project:project
              completionHandler: ^(array[EntiteType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeControllerApi()
var opts = { 
  'excludeType': 789, // {{Long}} excludeType
  'libCourt': libCourt_example, // {{String}} libCourt
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchEntites(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchEntitesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeControllerApi();
            var excludeType = 789;  // Long | excludeType (optional) 
            var libCourt = libCourt_example;  // String | libCourt (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Search EntiteTypes
                array[EntiteType] result = apiInstance.searchEntites(excludeType, libCourt, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeControllerApi.searchEntites: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeControllerApi();
$excludeType = 789; // Long | excludeType
$libCourt = libCourt_example; // String | libCourt
$project = 789; // Long | Project id

try {
    $result = $api_instance->searchEntites($excludeType, $libCourt, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeControllerApi->searchEntites: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeControllerApi->new();
my $excludeType = 789; # Long | excludeType
my $libCourt = libCourt_example; # String | libCourt
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->searchEntites(excludeType => $excludeType, libCourt => $libCourt, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeControllerApi->searchEntites: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeControllerApi()
excludeType = 789 # Long | excludeType (optional)
libCourt = libCourt_example # String | libCourt (optional)
project = 789 # Long | Project id (optional)

try: 
    # Search EntiteTypes
    api_response = api_instance.search_entites(excludeType=excludeType, libCourt=libCourt, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeControllerApi->searchEntites: %s\n" % e)

Parameters

Query parameters
Name Description
excludeType
Long (int64)
excludeType
libCourt
String
libCourt
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


EntiteTypeDepotLinkController

getEntiteDepotLinksUsingGET

getEntiteDepotLinks


/service/entite_depot/{uetId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/entite_depot/{uetId}?project=&withMappingCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntiteTypeDepotLinkControllerApi;

import java.io.File;
import java.util.*;

public class EntiteTypeDepotLinkControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        EntiteTypeDepotLinkControllerApi apiInstance = new EntiteTypeDepotLinkControllerApi();
        Long uetId = 789; // Long | uetId
        Long project = 789; // Long | Project id
        Boolean withMappingCount = true; // Boolean | withMappingCount
        try {
            array[EntiteTypeDepotLink] result = apiInstance.getEntiteDepotLinksUsingGET(uetId, project, withMappingCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeDepotLinkControllerApi#getEntiteDepotLinksUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntiteTypeDepotLinkControllerApi;

public class EntiteTypeDepotLinkControllerApiExample {

    public static void main(String[] args) {
        EntiteTypeDepotLinkControllerApi apiInstance = new EntiteTypeDepotLinkControllerApi();
        Long uetId = 789; // Long | uetId
        Long project = 789; // Long | Project id
        Boolean withMappingCount = true; // Boolean | withMappingCount
        try {
            array[EntiteTypeDepotLink] result = apiInstance.getEntiteDepotLinksUsingGET(uetId, project, withMappingCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntiteTypeDepotLinkControllerApi#getEntiteDepotLinksUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *uetId = 789; // uetId
Long *project = 789; // Project id (optional)
Boolean *withMappingCount = true; // withMappingCount (optional)

EntiteTypeDepotLinkControllerApi *apiInstance = [[EntiteTypeDepotLinkControllerApi alloc] init];

// getEntiteDepotLinks
[apiInstance getEntiteDepotLinksUsingGETWith:uetId
    project:project
    withMappingCount:withMappingCount
              completionHandler: ^(array[EntiteTypeDepotLink] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.EntiteTypeDepotLinkControllerApi()
var uetId = 789; // {{Long}} uetId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withMappingCount': true // {{Boolean}} withMappingCount
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEntiteDepotLinksUsingGET(uetId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEntiteDepotLinksUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EntiteTypeDepotLinkControllerApi();
            var uetId = 789;  // Long | uetId
            var project = 789;  // Long | Project id (optional) 
            var withMappingCount = true;  // Boolean | withMappingCount (optional) 

            try
            {
                // getEntiteDepotLinks
                array[EntiteTypeDepotLink] result = apiInstance.getEntiteDepotLinksUsingGET(uetId, project, withMappingCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntiteTypeDepotLinkControllerApi.getEntiteDepotLinksUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEntiteTypeDepotLinkControllerApi();
$uetId = 789; // Long | uetId
$project = 789; // Long | Project id
$withMappingCount = true; // Boolean | withMappingCount

try {
    $result = $api_instance->getEntiteDepotLinksUsingGET($uetId, $project, $withMappingCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntiteTypeDepotLinkControllerApi->getEntiteDepotLinksUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntiteTypeDepotLinkControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EntiteTypeDepotLinkControllerApi->new();
my $uetId = 789; # Long | uetId
my $project = 789; # Long | Project id
my $withMappingCount = true; # Boolean | withMappingCount

eval { 
    my $result = $api_instance->getEntiteDepotLinksUsingGET(uetId => $uetId, project => $project, withMappingCount => $withMappingCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntiteTypeDepotLinkControllerApi->getEntiteDepotLinksUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EntiteTypeDepotLinkControllerApi()
uetId = 789 # Long | uetId
project = 789 # Long | Project id (optional)
withMappingCount = true # Boolean | withMappingCount (optional)

try: 
    # getEntiteDepotLinks
    api_response = api_instance.get_entite_depot_links_using_get(uetId, project=project, withMappingCount=withMappingCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntiteTypeDepotLinkControllerApi->getEntiteDepotLinksUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
uetId*
Long (int64)
uetId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withMappingCount
Boolean
withMappingCount

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ExcelDepotController

createExcelDepot

create Excel Depot


/service/depots/excel

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExcelDepot body = ; // ExcelDepot | excelDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            ExcelDepot result = apiInstance.createExcelDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExcelDepot body = ; // ExcelDepot | excelDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            ExcelDepot result = apiInstance.createExcelDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExcelDepot *body = ; // excelDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// create Excel Depot
[apiInstance createExcelDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(ExcelDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{ExcelDepot}} excelDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExcelDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExcelDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new ExcelDepot(); // ExcelDepot | excelDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Excel Depot
                ExcelDepot result = apiInstance.createExcelDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.createExcelDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // ExcelDepot | excelDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createExcelDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->createExcelDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExcelDepot->new(); # ExcelDepot | excelDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createExcelDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->createExcelDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # ExcelDepot | excelDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Excel Depot
    api_response = api_instance.create_excel_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->createExcelDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createExcelDepotHeader

create Depot Header


/service/depots/excel/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createExcelDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createExcelDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createExcelDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExcelDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExcelDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createExcelDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.createExcelDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createExcelDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->createExcelDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createExcelDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->createExcelDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_excel_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->createExcelDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createExcelExtraction

create Extraction


/service/depots/excel/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createExcelExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createExcelExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// create Extraction
[apiInstance createExcelExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createExcelExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExcelExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createExcelExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.createExcelExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createExcelExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->createExcelExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createExcelExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->createExcelExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_excel_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->createExcelExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createExcelExtractionFilter

create Extraction Filter


/service/depots/excel/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createExcelExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createExcelExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#createExcelExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createExcelExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExcelExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExcelExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createExcelExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.createExcelExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createExcelExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->createExcelExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createExcelExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->createExcelExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_excel_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->createExcelExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllExcelDepotHeader

delete All DepotHeader


/service/depots/excel/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/excel/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllExcelDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteAllExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllExcelDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteAllExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// delete All DepotHeader
[apiInstance deleteAllExcelDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllExcelDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllExcelDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All DepotHeader
                apiInstance.deleteAllExcelDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.deleteAllExcelDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllExcelDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->deleteAllExcelDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllExcelDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->deleteAllExcelDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All DepotHeader
    api_instance.delete_all_excel_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->deleteAllExcelDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteExcelDepot

delete Excel Depot


/service/depots/excel/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/excel/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExcelDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExcelDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// delete Excel Depot
[apiInstance deleteExcelDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExcelDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExcelDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Excel Depot
                apiInstance.deleteExcelDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.deleteExcelDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteExcelDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->deleteExcelDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteExcelDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->deleteExcelDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # delete Excel Depot
    api_instance.delete_excel_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->deleteExcelDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteExcelDepotExtractions

delete Depot Extractions


/service/depots/excel/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteExcelDepotExtractions(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteExcelDepotExtractions(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// delete Depot Extractions
[apiInstance deleteExcelDepotExtractionsWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExcelDepotExtractions(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExcelDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Extractions
                Long result = apiInstance.deleteExcelDepotExtractions(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.deleteExcelDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteExcelDepotExtractions($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->deleteExcelDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteExcelDepotExtractions(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->deleteExcelDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Extractions
    api_response = api_instance.delete_excel_depot_extractions(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->deleteExcelDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteExcelDepotFileByName

delete excel file by name


/service/depots/excel/{depotId}/remote_files

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/excel/{depotId}/remote_files?ctx=&fileName=&isTemp=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExcelDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepotFileByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExcelDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepotFileByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Boolean *isTemp = true; // isTemp
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// delete excel file by name
[apiInstance deleteExcelDepotFileByNameWith:ctx
    depotId:depotId
    fileName:fileName
    isTemp:isTemp
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var isTemp = true; // {{Boolean}} isTemp
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExcelDepotFileByName(ctx, depotId, fileName, isTemp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExcelDepotFileByNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var isTemp = true;  // Boolean | isTemp
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete excel file by name
                apiInstance.deleteExcelDepotFileByName(ctx, depotId, fileName, isTemp, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.deleteExcelDepotFileByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$isTemp = true; // Boolean | isTemp
$project = 789; // Long | Project id

try {
    $api_instance->deleteExcelDepotFileByName($ctx, $depotId, $fileName, $isTemp, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->deleteExcelDepotFileByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $isTemp = true; # Boolean | isTemp
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteExcelDepotFileByName(ctx => $ctx, depotId => $depotId, fileName => $fileName, isTemp => $isTemp, project => $project);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->deleteExcelDepotFileByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
isTemp = true # Boolean | isTemp
project = 789 # Long | Project id (optional)

try: 
    # delete excel file by name
    api_instance.delete_excel_depot_file_by_name(ctx, depotId, fileName, isTemp, project=project)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->deleteExcelDepotFileByName: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
isTemp*
Boolean
isTemp
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteExcelDepotHeader

delete Depot Header


/service/depots/excel/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteExcelDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteExcelDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteExcelDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExcelDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExcelDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteExcelDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.deleteExcelDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteExcelDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->deleteExcelDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteExcelDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->deleteExcelDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_excel_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->deleteExcelDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteExcelExtraction

delete Extraction


/service/depots/excel/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/excel/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExcelExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExcelExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#deleteExcelExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteExcelExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExcelExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExcelExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteExcelExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.deleteExcelExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteExcelExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->deleteExcelExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteExcelExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->deleteExcelExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_excel_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->deleteExcelExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


downloadLocalExcelFile

Download local excel file


/service/depot/excel/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depot/excel/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalExcelFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#downloadLocalExcelFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalExcelFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#downloadLocalExcelFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Download local excel file
[apiInstance downloadLocalExcelFileWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadLocalExcelFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadLocalExcelFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download local excel file
                apiInstance.downloadLocalExcelFile(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.downloadLocalExcelFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadLocalExcelFile($token);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->downloadLocalExcelFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadLocalExcelFile(token => $token);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->downloadLocalExcelFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download local excel file
    api_instance.download_local_excel_file(token=token)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->downloadLocalExcelFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editExcelDepot

edit Excel Depot


/service/depots/excel/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExcelDepot body = ; // ExcelDepot | excelDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExcelDepot result = apiInstance.editExcelDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#editExcelDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExcelDepot body = ; // ExcelDepot | excelDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExcelDepot result = apiInstance.editExcelDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#editExcelDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExcelDepot *body = ; // excelDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// edit Excel Depot
[apiInstance editExcelDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(ExcelDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{ExcelDepot}} excelDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editExcelDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editExcelDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new ExcelDepot(); // ExcelDepot | excelDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Excel Depot
                ExcelDepot result = apiInstance.editExcelDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.editExcelDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // ExcelDepot | excelDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editExcelDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->editExcelDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExcelDepot->new(); # ExcelDepot | excelDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editExcelDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->editExcelDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # ExcelDepot | excelDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # edit Excel Depot
    api_response = api_instance.edit_excel_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->editExcelDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editExcelDepotHeader

edit Depot Header


/service/depots/excel/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editExcelDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#editExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editExcelDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#editExcelDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editExcelDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editExcelDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editExcelDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editExcelDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.editExcelDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editExcelDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->editExcelDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editExcelDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->editExcelDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_excel_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->editExcelDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editExcelExtractionFilter

edit Extraction Filter


/service/depots/excel/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editExcelExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#editExcelExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editExcelExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#editExcelExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editExcelExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editExcelExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editExcelExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editExcelExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.editExcelExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editExcelExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->editExcelExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editExcelExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->editExcelExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_excel_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->editExcelExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllExcelDepot

find All Excel Depot


/service/depots/excel

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[ExcelDepot] result = apiInstance.findAllExcelDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#findAllExcelDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[ExcelDepot] result = apiInstance.findAllExcelDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#findAllExcelDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// find All Excel Depot
[apiInstance findAllExcelDepotWith:project
              completionHandler: ^(array[ExcelDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllExcelDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllExcelDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Excel Depot
                array[ExcelDepot] result = apiInstance.findAllExcelDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.findAllExcelDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllExcelDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->findAllExcelDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllExcelDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->findAllExcelDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # find All Excel Depot
    api_response = api_instance.find_all_excel_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->findAllExcelDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllExcelExtractionFilters

find All Extraction Filters


/service/depots/excel/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllExcelExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#findAllExcelExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllExcelExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#findAllExcelExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllExcelExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllExcelExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllExcelExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllExcelExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.findAllExcelExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllExcelExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->findAllExcelExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllExcelExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->findAllExcelExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_excel_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->findAllExcelExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneExcelDepotById

find One Excel Depot By Id


/service/depots/excel/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            ExcelDepot result = apiInstance.findOneExcelDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#findOneExcelDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            ExcelDepot result = apiInstance.findOneExcelDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#findOneExcelDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// find One Excel Depot By Id
[apiInstance findOneExcelDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(ExcelDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneExcelDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneExcelDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // find One Excel Depot By Id
                ExcelDepot result = apiInstance.findOneExcelDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.findOneExcelDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneExcelDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->findOneExcelDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneExcelDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->findOneExcelDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # find One Excel Depot By Id
    api_response = api_instance.find_one_excel_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->findOneExcelDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelDepotExtractions

get Depot Extractions


/service/depots/excel/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getExcelDepotExtractions(depotId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getExcelDepotExtractions(depotId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getExcelDepotExtractionsWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelDepotExtractions(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getExcelDepotExtractions(depotId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExcelDepotExtractions($depotId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExcelDepotExtractions(depotId => $depotId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_excel_depot_extractions(depotId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelDepotFilesCount

get Depot Files Count


/service/depots/excel/{depotId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/count?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getExcelDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotFilesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getExcelDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotFilesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// get Depot Files Count
[apiInstance getExcelDepotFilesCountWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelDepotFilesCount(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelDepotFilesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Files Count
                Long result = apiInstance.getExcelDepotFilesCount(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelDepotFilesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExcelDepotFilesCount($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelDepotFilesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExcelDepotFilesCount(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelDepotFilesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Files Count
    api_response = api_instance.get_excel_depot_files_count(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelDepotFilesCount: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelDepotHeadersByDepotId

get Depot Headers By DepotId


/service/depots/excel/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getExcelDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getExcelDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// get Depot Headers By DepotId
[apiInstance getExcelDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By DepotId
                array[DepotHeader] result = apiInstance.getExcelDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExcelDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExcelDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By DepotId
    api_response = api_instance.get_excel_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelDepotRemoteFiles

Get excel depot remoteFiles


/service/depots/excel/{depotId}/remote_files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/remote_files?ctx=&filenameMask=&includeTemp=&limit=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getExcelDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getExcelDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *filenameMask = filenameMask_example; // filenameMask
Boolean *includeTemp = true; // includeTemp
Integer *limit = 56; // limit
Long *project = 789; // Project id (optional)
String *remotePath = remotePath_example; // remotePath (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Get excel depot remoteFiles
[apiInstance getExcelDepotRemoteFilesWith:ctx
    depotId:depotId
    filenameMask:filenameMask
    includeTemp:includeTemp
    limit:limit
    project:project
    remotePath:remotePath
              completionHandler: ^(array[RemoteFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var filenameMask = filenameMask_example; // {{String}} filenameMask
var includeTemp = true; // {{Boolean}} includeTemp
var limit = 56; // {{Integer}} limit
var opts = { 
  'project': 789, // {{Long}} Project id
  'remotePath': remotePath_example // {{String}} remotePath
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelDepotRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var filenameMask = filenameMask_example;  // String | filenameMask
            var includeTemp = true;  // Boolean | includeTemp
            var limit = 56;  // Integer | limit
            var project = 789;  // Long | Project id (optional) 
            var remotePath = remotePath_example;  // String | remotePath (optional) 

            try
            {
                // Get excel depot remoteFiles
                array[RemoteFile] result = apiInstance.getExcelDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelDepotRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$filenameMask = filenameMask_example; // String | filenameMask
$includeTemp = true; // Boolean | includeTemp
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$remotePath = remotePath_example; // String | remotePath

try {
    $result = $api_instance->getExcelDepotRemoteFiles($ctx, $depotId, $filenameMask, $includeTemp, $limit, $project, $remotePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelDepotRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $filenameMask = filenameMask_example; # String | filenameMask
my $includeTemp = true; # Boolean | includeTemp
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $remotePath = remotePath_example; # String | remotePath

eval { 
    my $result = $api_instance->getExcelDepotRemoteFiles(ctx => $ctx, depotId => $depotId, filenameMask => $filenameMask, includeTemp => $includeTemp, limit => $limit, project => $project, remotePath => $remotePath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelDepotRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
filenameMask = filenameMask_example # String | filenameMask
includeTemp = true # Boolean | includeTemp
limit = 56 # Integer | limit
project = 789 # Long | Project id (optional)
remotePath = remotePath_example # String | remotePath (optional)

try: 
    # Get excel depot remoteFiles
    api_response = api_instance.get_excel_depot_remote_files(ctx, depotId, filenameMask, includeTemp, limit, project=project, remotePath=remotePath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelDepotRemoteFiles: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filenameMask*
String
filenameMask
Required
includeTemp*
Boolean
includeTemp
Required
limit*
Integer (int32)
limit
Required
project
Long (int64)
Project id
remotePath
String
remotePath

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelExtractionFilePreview

get Extraction File Preview


/service/depots/excel/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getExcelExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getExcelExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getExcelExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getExcelExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getExcelExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getExcelExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_excel_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelFileDownloadToken

Get download token for a local excel file


/service/depot/excel/{depotId}/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/depot/excel/{depotId}/file/token?fileName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getExcelFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelFileDownloadToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getExcelFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelFileDownloadToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Get download token for a local excel file
[apiInstance getExcelFileDownloadTokenWith:depotId
    fileName:fileName
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelFileDownloadToken(depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelFileDownloadTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get download token for a local excel file
                'String' result = apiInstance.getExcelFileDownloadToken(depotId, fileName, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelFileDownloadToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExcelFileDownloadToken($depotId, $fileName, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelFileDownloadToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExcelFileDownloadToken(depotId => $depotId, fileName => $fileName, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelFileDownloadToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)

try: 
    # Get download token for a local excel file
    api_response = api_instance.get_excel_file_download_token(depotId, fileName, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelFileDownloadToken: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
fileName*
String
fileName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExcelPreviewDepot

Get EXCEL depot preview


/service/depots/excel/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getExcelPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getExcelPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getExcelPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Get EXCEL depot preview
[apiInstance getExcelPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExcelPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExcelPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get EXCEL depot preview
                DepotData result = apiInstance.getExcelPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getExcelPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExcelPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getExcelPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExcelPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getExcelPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get EXCEL depot preview
    api_response = api_instance.get_excel_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getExcelPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersFromExcelDepot

Get headers from a excel depot


/service/depots/excel/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/headers?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExcelDepot body = ; // ExcelDepot | excelDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromExcelDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getHeadersFromExcelDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        ExcelDepot body = ; // ExcelDepot | excelDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromExcelDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#getHeadersFromExcelDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExcelDepot *body = ; // excelDepot
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Get headers from a excel depot
[apiInstance getHeadersFromExcelDepotWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{ExcelDepot}} excelDepot
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersFromExcelDepot(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersFromExcelDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new ExcelDepot(); // ExcelDepot | excelDepot
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a excel depot
                array[array[Object]] result = apiInstance.getHeadersFromExcelDepot(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.getHeadersFromExcelDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // ExcelDepot | excelDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHeadersFromExcelDepot($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->getHeadersFromExcelDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExcelDepot->new(); # ExcelDepot | excelDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHeadersFromExcelDepot(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->getHeadersFromExcelDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # ExcelDepot | excelDepot
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a excel depot
    api_response = api_instance.get_headers_from_excel_depot(body, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->getHeadersFromExcelDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleExcelFileUpload

Upload an excel file to a depot


/service/depots/excel/upload_file

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/upload_file?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleExcelFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#handleExcelFileUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleExcelFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#handleExcelFileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Upload an excel file to a depot
[apiInstance handleExcelFileUploadWith:ctx
    project:project
              completionHandler: ^(FileUpload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleExcelFileUpload(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleExcelFileUploadExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Upload an excel file to a depot
                FileUpload result = apiInstance.handleExcelFileUpload(ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.handleExcelFileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleExcelFileUpload($ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->handleExcelFileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleExcelFileUpload(ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->handleExcelFileUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Upload an excel file to a depot
    api_response = api_instance.handle_excel_file_upload(ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->handleExcelFileUpload: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveExcelDepotTempFolderOnTypeUpdate

move temp folder when type is changed


/service/depots/excel/move_tmp_folder_on_type_update

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/excel/move_tmp_folder_on_type_update?ctx=&depotCode=&newDepotType=&oldDepotType=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveExcelDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#moveExcelDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveExcelDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#moveExcelDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *depotCode = depotCode_example; // depotCode
String *newDepotType = newDepotType_example; // newDepotType
String *oldDepotType = oldDepotType_example; // oldDepotType
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// move temp folder when type is changed
[apiInstance moveExcelDepotTempFolderOnTypeUpdateWith:ctx
    depotCode:depotCode
    newDepotType:newDepotType
    oldDepotType:oldDepotType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotCode = depotCode_example; // {{String}} depotCode
var newDepotType = newDepotType_example; // {{String}} newDepotType
var oldDepotType = oldDepotType_example; // {{String}} oldDepotType
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveExcelDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveExcelDepotTempFolderOnTypeUpdateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotCode = depotCode_example;  // String | depotCode
            var newDepotType = newDepotType_example;  // String | newDepotType
            var oldDepotType = oldDepotType_example;  // String | oldDepotType
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // move temp folder when type is changed
                apiInstance.moveExcelDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.moveExcelDepotTempFolderOnTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotCode = depotCode_example; // String | depotCode
$newDepotType = newDepotType_example; // String | newDepotType
$oldDepotType = oldDepotType_example; // String | oldDepotType
$project = 789; // Long | Project id

try {
    $api_instance->moveExcelDepotTempFolderOnTypeUpdate($ctx, $depotCode, $newDepotType, $oldDepotType, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->moveExcelDepotTempFolderOnTypeUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotCode = depotCode_example; # String | depotCode
my $newDepotType = newDepotType_example; # String | newDepotType
my $oldDepotType = oldDepotType_example; # String | oldDepotType
my $project = 789; # Long | Project id

eval { 
    $api_instance->moveExcelDepotTempFolderOnTypeUpdate(ctx => $ctx, depotCode => $depotCode, newDepotType => $newDepotType, oldDepotType => $oldDepotType, project => $project);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->moveExcelDepotTempFolderOnTypeUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotCode = depotCode_example # String | depotCode
newDepotType = newDepotType_example # String | newDepotType
oldDepotType = oldDepotType_example # String | oldDepotType
project = 789 # Long | Project id (optional)

try: 
    # move temp folder when type is changed
    api_instance.move_excel_depot_temp_folder_on_type_update(ctx, depotCode, newDepotType, oldDepotType, project=project)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->moveExcelDepotTempFolderOnTypeUpdate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotCode*
String
depotCode
Required
newDepotType*
String
newDepotType
Required
oldDepotType*
String
oldDepotType
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


previewRemoteExcelFile

Get excel file preview


/service/depots/excel/{depotId}/remote_files/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/excel/{depotId}/remote_files/preview?ctx=&fileName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteExcelFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#previewRemoteExcelFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteExcelFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#previewRemoteExcelFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// Get excel file preview
[apiInstance previewRemoteExcelFileWith:ctx
    depotId:depotId
    fileName:fileName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewRemoteExcelFile(ctx, depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewRemoteExcelFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Get excel file preview
                DepotData result = apiInstance.previewRemoteExcelFile(ctx, depotId, fileName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.previewRemoteExcelFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->previewRemoteExcelFile($ctx, $depotId, $fileName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->previewRemoteExcelFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->previewRemoteExcelFile(ctx => $ctx, depotId => $depotId, fileName => $fileName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->previewRemoteExcelFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Get excel file preview
    api_response = api_instance.preview_remote_excel_file(ctx, depotId, fileName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->previewRemoteExcelFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateExcelDepotActivationStatus

update Depot Activation Status


/service/depots/excel/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/excel/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateExcelDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#updateExcelDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateExcelDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#updateExcelDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateExcelDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateExcelDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExcelDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateExcelDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.updateExcelDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateExcelDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->updateExcelDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateExcelDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->updateExcelDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_excel_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->updateExcelDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateExcelDepotHeadersPositions

update Depot Headers Positions


/service/depots/excel/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/excel/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExcelDepotControllerApi;

import java.io.File;
import java.util.*;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateExcelDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#updateExcelDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExcelDepotControllerApi;

public class ExcelDepotControllerApiExample {

    public static void main(String[] args) {
        ExcelDepotControllerApi apiInstance = new ExcelDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateExcelDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExcelDepotControllerApi#updateExcelDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ExcelDepotControllerApi *apiInstance = [[ExcelDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateExcelDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExcelDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateExcelDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExcelDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExcelDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateExcelDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExcelDepotControllerApi.updateExcelDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExcelDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateExcelDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling ExcelDepotControllerApi->updateExcelDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExcelDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExcelDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateExcelDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling ExcelDepotControllerApi->updateExcelDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExcelDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_excel_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling ExcelDepotControllerApi->updateExcelDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


ExportController

datablockExportExecutionTask

datablockExportExecutionTask


/service/v8/datablocks/{datablockId}/export

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/v8/datablocks/{datablockId}/export?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportControllerApi;

import java.io.File;
import java.util.*;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportControllerApi apiInstance = new ExportControllerApi();
        ExportTemplateConfigDTO body = ; // ExportTemplateConfigDTO | exportTemplate
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobTracking result = apiInstance.datablockExportExecutionTask(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#datablockExportExecutionTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportControllerApi;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ExportControllerApi apiInstance = new ExportControllerApi();
        ExportTemplateConfigDTO body = ; // ExportTemplateConfigDTO | exportTemplate
        Long datablockId = 789; // Long | datablockId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobTracking result = apiInstance.datablockExportExecutionTask(body, datablockId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#datablockExportExecutionTask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportTemplateConfigDTO *body = ; // exportTemplate
Long *datablockId = 789; // datablockId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ExportControllerApi *apiInstance = [[ExportControllerApi alloc] init];

// datablockExportExecutionTask
[apiInstance datablockExportExecutionTaskWith:body
    datablockId:datablockId
    ctx:ctx
    project:project
              completionHandler: ^(JobTracking output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportControllerApi()
var body = ; // {{ExportTemplateConfigDTO}} exportTemplate
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.datablockExportExecutionTask(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class datablockExportExecutionTaskExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportControllerApi();
            var body = new ExportTemplateConfigDTO(); // ExportTemplateConfigDTO | exportTemplate
            var datablockId = 789;  // Long | datablockId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // datablockExportExecutionTask
                JobTracking result = apiInstance.datablockExportExecutionTask(body, datablockId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportControllerApi.datablockExportExecutionTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportControllerApi();
$body = ; // ExportTemplateConfigDTO | exportTemplate
$datablockId = 789; // Long | datablockId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->datablockExportExecutionTask($body, $datablockId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->datablockExportExecutionTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExportTemplateConfigDTO->new(); # ExportTemplateConfigDTO | exportTemplate
my $datablockId = 789; # Long | datablockId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->datablockExportExecutionTask(body => $body, datablockId => $datablockId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->datablockExportExecutionTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportControllerApi()
body =  # ExportTemplateConfigDTO | exportTemplate
datablockId = 789 # Long | datablockId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # datablockExportExecutionTask
    api_response = api_instance.datablock_export_execution_task(body, datablockId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportControllerApi->datablockExportExecutionTask: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


datablockExportExecutionTaskPrivate

datablockExportExecutionTaskPrivate


/service/private/v8/datablocks/{datablockId}/export

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/private/v8/datablocks/{datablockId}/export?clientId=&ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportControllerApi;

import java.io.File;
import java.util.*;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportControllerApi apiInstance = new ExportControllerApi();
        ExportTemplateConfigDTO body = ; // ExportTemplateConfigDTO | exportTemplate
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | client id
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobTracking result = apiInstance.datablockExportExecutionTaskPrivate(body, datablockId, clientId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#datablockExportExecutionTaskPrivate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportControllerApi;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ExportControllerApi apiInstance = new ExportControllerApi();
        ExportTemplateConfigDTO body = ; // ExportTemplateConfigDTO | exportTemplate
        Long datablockId = 789; // Long | datablockId
        String clientId = clientId_example; // String | client id
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobTracking result = apiInstance.datablockExportExecutionTaskPrivate(body, datablockId, clientId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#datablockExportExecutionTaskPrivate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportTemplateConfigDTO *body = ; // exportTemplate
Long *datablockId = 789; // datablockId
String *clientId = clientId_example; // client id (optional)
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ExportControllerApi *apiInstance = [[ExportControllerApi alloc] init];

// datablockExportExecutionTaskPrivate
[apiInstance datablockExportExecutionTaskPrivateWith:body
    datablockId:datablockId
    clientId:clientId
    ctx:ctx
    project:project
              completionHandler: ^(JobTracking output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportControllerApi()
var body = ; // {{ExportTemplateConfigDTO}} exportTemplate
var datablockId = 789; // {{Long}} datablockId
var opts = { 
  'clientId': clientId_example // {{String}} client id
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.datablockExportExecutionTaskPrivate(bodydatablockId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class datablockExportExecutionTaskPrivateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportControllerApi();
            var body = new ExportTemplateConfigDTO(); // ExportTemplateConfigDTO | exportTemplate
            var datablockId = 789;  // Long | datablockId
            var clientId = clientId_example;  // String | client id (optional) 
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // datablockExportExecutionTaskPrivate
                JobTracking result = apiInstance.datablockExportExecutionTaskPrivate(body, datablockId, clientId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportControllerApi.datablockExportExecutionTaskPrivate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportControllerApi();
$body = ; // ExportTemplateConfigDTO | exportTemplate
$datablockId = 789; // Long | datablockId
$clientId = clientId_example; // String | client id
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->datablockExportExecutionTaskPrivate($body, $datablockId, $clientId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->datablockExportExecutionTaskPrivate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExportTemplateConfigDTO->new(); # ExportTemplateConfigDTO | exportTemplate
my $datablockId = 789; # Long | datablockId
my $clientId = clientId_example; # String | client id
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->datablockExportExecutionTaskPrivate(body => $body, datablockId => $datablockId, clientId => $clientId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->datablockExportExecutionTaskPrivate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportControllerApi()
body =  # ExportTemplateConfigDTO | exportTemplate
datablockId = 789 # Long | datablockId
clientId = clientId_example # String | client id (optional)
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # datablockExportExecutionTaskPrivate
    api_response = api_instance.datablock_export_execution_task_private(body, datablockId, clientId=clientId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportControllerApi->datablockExportExecutionTaskPrivate: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
clientId
String
client id
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


datablockExportExecutionTaskUsingTemplateIdAsync

datablockExportExecutionTaskUsingTemplateIdAsync


/service/v8/datablocks/{datablockId}/export/{templateId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/{datablockId}/export/{templateId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportControllerApi;

import java.io.File;
import java.util.*;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportControllerApi apiInstance = new ExportControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long templateId = 789; // Long | templateId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobTracking result = apiInstance.datablockExportExecutionTaskUsingTemplateIdAsync(datablockId, templateId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#datablockExportExecutionTaskUsingTemplateIdAsync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportControllerApi;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ExportControllerApi apiInstance = new ExportControllerApi();
        Long datablockId = 789; // Long | datablockId
        Long templateId = 789; // Long | templateId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobTracking result = apiInstance.datablockExportExecutionTaskUsingTemplateIdAsync(datablockId, templateId, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#datablockExportExecutionTaskUsingTemplateIdAsync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *datablockId = 789; // datablockId
Long *templateId = 789; // templateId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ExportControllerApi *apiInstance = [[ExportControllerApi alloc] init];

// datablockExportExecutionTaskUsingTemplateIdAsync
[apiInstance datablockExportExecutionTaskUsingTemplateIdAsyncWith:datablockId
    templateId:templateId
    ctx:ctx
    project:project
              completionHandler: ^(JobTracking output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportControllerApi()
var datablockId = 789; // {{Long}} datablockId
var templateId = 789; // {{Long}} templateId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.datablockExportExecutionTaskUsingTemplateIdAsync(datablockId, templateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class datablockExportExecutionTaskUsingTemplateIdAsyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportControllerApi();
            var datablockId = 789;  // Long | datablockId
            var templateId = 789;  // Long | templateId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // datablockExportExecutionTaskUsingTemplateIdAsync
                JobTracking result = apiInstance.datablockExportExecutionTaskUsingTemplateIdAsync(datablockId, templateId, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportControllerApi.datablockExportExecutionTaskUsingTemplateIdAsync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportControllerApi();
$datablockId = 789; // Long | datablockId
$templateId = 789; // Long | templateId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->datablockExportExecutionTaskUsingTemplateIdAsync($datablockId, $templateId, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->datablockExportExecutionTaskUsingTemplateIdAsync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportControllerApi->new();
my $datablockId = 789; # Long | datablockId
my $templateId = 789; # Long | templateId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->datablockExportExecutionTaskUsingTemplateIdAsync(datablockId => $datablockId, templateId => $templateId, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->datablockExportExecutionTaskUsingTemplateIdAsync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportControllerApi()
datablockId = 789 # Long | datablockId
templateId = 789 # Long | templateId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # datablockExportExecutionTaskUsingTemplateIdAsync
    api_response = api_instance.datablock_export_execution_task_using_template_id_async(datablockId, templateId, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportControllerApi->datablockExportExecutionTaskUsingTemplateIdAsync: %s\n" % e)

Parameters

Path parameters
Name Description
datablockId*
Long (int64)
datablockId
Required
templateId*
Long (int64)
templateId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExportHistoryFiles

getExportHistoryFiles

This endpoint is no longer supported (since 8.2.0). Use v8/datablocks/export/{jobId}/files instead.


/service/export/datablock/files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/export/datablock/files?ctx=&id=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportControllerApi;

import java.io.File;
import java.util.*;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportControllerApi apiInstance = new ExportControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getExportHistoryFiles(ctx, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#getExportHistoryFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportControllerApi;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ExportControllerApi apiInstance = new ExportControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long id = 789; // Long | id
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getExportHistoryFiles(ctx, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#getExportHistoryFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *id = 789; // id
Long *project = 789; // Project id (optional)

ExportControllerApi *apiInstance = [[ExportControllerApi alloc] init];

// getExportHistoryFiles
[apiInstance getExportHistoryFilesWith:ctx
    id:id
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportControllerApi()
var ctx = 56; // {{Integer}} ctx
var id = 789; // {{Long}} id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportHistoryFiles(ctx, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportHistoryFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportControllerApi();
            var ctx = 56;  // Integer | ctx
            var id = 789;  // Long | id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // getExportHistoryFiles
                array['String'] result = apiInstance.getExportHistoryFiles(ctx, id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportControllerApi.getExportHistoryFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportControllerApi();
$ctx = 56; // Integer | ctx
$id = 789; // Long | id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExportHistoryFiles($ctx, $id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->getExportHistoryFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportControllerApi->new();
my $ctx = 56; # Integer | ctx
my $id = 789; # Long | id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExportHistoryFiles(ctx => $ctx, id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->getExportHistoryFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportControllerApi()
ctx = 56 # Integer | ctx
id = 789 # Long | id
project = 789 # Long | Project id (optional)

try: 
    # getExportHistoryFiles
    api_response = api_instance.get_export_history_files(ctx, id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportControllerApi->getExportHistoryFiles: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
id*
Long (int64)
id
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExportedFiles

Get exported files


/service/v8/datablocks/export/{jobId}/files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/export/{jobId}/files?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportControllerApi;

import java.io.File;
import java.util.*;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportControllerApi apiInstance = new ExportControllerApi();
        Integer ctx = 56; // Integer | ctx
        String jobId = jobId_example; // String | jobId
        Long project = 789; // Long | Project id
        try {
            array[DownloadableFile] result = apiInstance.getExportedFiles(ctx, jobId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#getExportedFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportControllerApi;

public class ExportControllerApiExample {

    public static void main(String[] args) {
        ExportControllerApi apiInstance = new ExportControllerApi();
        Integer ctx = 56; // Integer | ctx
        String jobId = jobId_example; // String | jobId
        Long project = 789; // Long | Project id
        try {
            array[DownloadableFile] result = apiInstance.getExportedFiles(ctx, jobId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportControllerApi#getExportedFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *jobId = jobId_example; // jobId
Long *project = 789; // Project id (optional)

ExportControllerApi *apiInstance = [[ExportControllerApi alloc] init];

// Get exported files
[apiInstance getExportedFilesWith:ctx
    jobId:jobId
    project:project
              completionHandler: ^(array[DownloadableFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportControllerApi()
var ctx = 56; // {{Integer}} ctx
var jobId = jobId_example; // {{String}} jobId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportedFiles(ctx, jobId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportedFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportControllerApi();
            var ctx = 56;  // Integer | ctx
            var jobId = jobId_example;  // String | jobId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get exported files
                array[DownloadableFile] result = apiInstance.getExportedFiles(ctx, jobId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportControllerApi.getExportedFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportControllerApi();
$ctx = 56; // Integer | ctx
$jobId = jobId_example; // String | jobId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getExportedFiles($ctx, $jobId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->getExportedFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportControllerApi->new();
my $ctx = 56; # Integer | ctx
my $jobId = jobId_example; # String | jobId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExportedFiles(ctx => $ctx, jobId => $jobId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->getExportedFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportControllerApi()
ctx = 56 # Integer | ctx
jobId = jobId_example # String | jobId
project = 789 # Long | Project id (optional)

try: 
    # Get exported files
    api_response = api_instance.get_exported_files(ctx, jobId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportControllerApi->getExportedFiles: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
jobId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ExportTemplateController

createExportTemplate

create export template


/service/private/v8/datablocks/export/templates

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/private/v8/datablocks/export/templates?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        ExportTemplateDTO body = ; // ExportTemplateDTO | exportTemplateDTO
        Long project = 789; // Long | Project id
        try {
            ExportTemplateDTO result = apiInstance.createExportTemplate(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#createExportTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        ExportTemplateDTO body = ; // ExportTemplateDTO | exportTemplateDTO
        Long project = 789; // Long | Project id
        try {
            ExportTemplateDTO result = apiInstance.createExportTemplate(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#createExportTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportTemplateDTO *body = ; // exportTemplateDTO
Long *project = 789; // Project id (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// create  export template
[apiInstance createExportTemplateWith:body
    project:project
              completionHandler: ^(ExportTemplateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var body = ; // {{ExportTemplateDTO}} exportTemplateDTO
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExportTemplate(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExportTemplateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var body = new ExportTemplateDTO(); // ExportTemplateDTO | exportTemplateDTO
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create  export template
                ExportTemplateDTO result = apiInstance.createExportTemplate(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.createExportTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$body = ; // ExportTemplateDTO | exportTemplateDTO
$project = 789; // Long | Project id

try {
    $result = $api_instance->createExportTemplate($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->createExportTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExportTemplateDTO->new(); # ExportTemplateDTO | exportTemplateDTO
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createExportTemplate(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->createExportTemplate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
body =  # ExportTemplateDTO | exportTemplateDTO
project = 789 # Long | Project id (optional)

try: 
    # create  export template
    api_response = api_instance.create_export_template(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->createExportTemplate: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteExportTemplateById

delete export template


/service/private/v8/datablocks/export/templates/{templateId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/private/v8/datablocks/export/templates/{templateId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Long templateId = 789; // Long | templateId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExportTemplateById(templateId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#deleteExportTemplateById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Long templateId = 789; // Long | templateId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExportTemplateById(templateId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#deleteExportTemplateById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *templateId = 789; // templateId
Long *project = 789; // Project id (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// delete  export template
[apiInstance deleteExportTemplateByIdWith:templateId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var templateId = 789; // {{Long}} templateId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExportTemplateById(templateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExportTemplateByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var templateId = 789;  // Long | templateId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete  export template
                apiInstance.deleteExportTemplateById(templateId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.deleteExportTemplateById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$templateId = 789; // Long | templateId
$project = 789; // Long | Project id

try {
    $api_instance->deleteExportTemplateById($templateId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->deleteExportTemplateById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $templateId = 789; # Long | templateId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteExportTemplateById(templateId => $templateId, project => $project);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->deleteExportTemplateById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
templateId = 789 # Long | templateId
project = 789 # Long | Project id (optional)

try: 
    # delete  export template
    api_instance.delete_export_template_by_id(templateId, project=project)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->deleteExportTemplateById: %s\n" % e)

Parameters

Path parameters
Name Description
templateId*
Long (int64)
templateId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteExportTemplates

Delete export templates by IDs


/service/private/v8/datablocks/export/templates

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/private/v8/datablocks/export/templates?project=&templatesIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        array[Long] templatesIds = ; // array[Long] | templatesIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExportTemplates(templatesIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#deleteExportTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        array[Long] templatesIds = ; // array[Long] | templatesIds
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteExportTemplates(templatesIds, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#deleteExportTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *templatesIds = ; // templatesIds
Long *project = 789; // Project id (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// Delete export templates by IDs
[apiInstance deleteExportTemplatesWith:templatesIds
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var templatesIds = ; // {{array[Long]}} templatesIds
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteExportTemplates(templatesIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExportTemplatesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var templatesIds = new array[Long](); // array[Long] | templatesIds
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete export templates by IDs
                apiInstance.deleteExportTemplates(templatesIds, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.deleteExportTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$templatesIds = ; // array[Long] | templatesIds
$project = 789; // Long | Project id

try {
    $api_instance->deleteExportTemplates($templatesIds, $project);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->deleteExportTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $templatesIds = []; # array[Long] | templatesIds
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteExportTemplates(templatesIds => $templatesIds, project => $project);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->deleteExportTemplates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
templatesIds =  # array[Long] | templatesIds
project = 789 # Long | Project id (optional)

try: 
    # Delete export templates by IDs
    api_instance.delete_export_templates(templatesIds, project=project)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->deleteExportTemplates: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id
templatesIds*
array[Long] (int64)
templatesIds
Required

Responses

Status: 200 - OK


findAllExportTemplates

find All export templates


/service/v8/datablocks/export/templates

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/export/templates?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[ExportTemplateDTO] result = apiInstance.findAllExportTemplates(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#findAllExportTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[ExportTemplateDTO] result = apiInstance.findAllExportTemplates(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#findAllExportTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// find All  export templates
[apiInstance findAllExportTemplatesWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[ExportTemplateDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllExportTemplates(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllExportTemplatesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All  export templates
                array[ExportTemplateDTO] result = apiInstance.findAllExportTemplates(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.findAllExportTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllExportTemplates($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->findAllExportTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllExportTemplates(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->findAllExportTemplates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # find All  export templates
    api_response = api_instance.find_all_export_templates(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->findAllExportTemplates: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneExportTemplateById

find One export template By Id


/service/v8/datablocks/export/templates/{templateId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/export/templates/{templateId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Long templateId = 789; // Long | templateId
        Long project = 789; // Long | Project id
        try {
            ExportTemplateDTO result = apiInstance.findOneExportTemplateById(templateId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#findOneExportTemplateById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Long templateId = 789; // Long | templateId
        Long project = 789; // Long | Project id
        try {
            ExportTemplateDTO result = apiInstance.findOneExportTemplateById(templateId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#findOneExportTemplateById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *templateId = 789; // templateId
Long *project = 789; // Project id (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// find One  export template By Id
[apiInstance findOneExportTemplateByIdWith:templateId
    project:project
              completionHandler: ^(ExportTemplateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var templateId = 789; // {{Long}} templateId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneExportTemplateById(templateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneExportTemplateByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var templateId = 789;  // Long | templateId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find One  export template By Id
                ExportTemplateDTO result = apiInstance.findOneExportTemplateById(templateId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.findOneExportTemplateById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$templateId = 789; // Long | templateId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneExportTemplateById($templateId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->findOneExportTemplateById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $templateId = 789; # Long | templateId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneExportTemplateById(templateId => $templateId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->findOneExportTemplateById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
templateId = 789 # Long | templateId
project = 789 # Long | Project id (optional)

try: 
    # find One  export template By Id
    api_response = api_instance.find_one_export_template_by_id(templateId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->findOneExportTemplateById: %s\n" % e)

Parameters

Path parameters
Name Description
templateId*
Long (int64)
templateId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


search_for_export_template

find All export templates


/service/v8/datablocks/export/templates/search

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/v8/datablocks/export/templates/search?excludePublic=&project=&searchTerm="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        String searchTerm = searchTerm_example; // String | search term
        try {
            array[ExportTemplateDTO] result = apiInstance.search_for_export_template(excludePublic, project, searchTerm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#search_for_export_template");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        String searchTerm = searchTerm_example; // String | search term
        try {
            array[ExportTemplateDTO] result = apiInstance.search_for_export_template(excludePublic, project, searchTerm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#search_for_export_template");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)
String *searchTerm = searchTerm_example; // search term (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// find All  export templates
[apiInstance search_for_export_templateWith:excludePublic
    project:project
    searchTerm:searchTerm
              completionHandler: ^(array[ExportTemplateDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var opts = { 
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789, // {{Long}} Project id
  'searchTerm': searchTerm_example // {{String}} search term
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_for_export_template(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class search_for_export_templateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 
            var searchTerm = searchTerm_example;  // String | search term (optional) 

            try
            {
                // find All  export templates
                array[ExportTemplateDTO] result = apiInstance.search_for_export_template(excludePublic, project, searchTerm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.search_for_export_template: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id
$searchTerm = searchTerm_example; // String | search term

try {
    $result = $api_instance->search_for_export_template($excludePublic, $project, $searchTerm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->search_for_export_template: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id
my $searchTerm = searchTerm_example; # String | search term

eval { 
    my $result = $api_instance->search_for_export_template(excludePublic => $excludePublic, project => $project, searchTerm => $searchTerm);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->search_for_export_template: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)
searchTerm = searchTerm_example # String | search term (optional)

try: 
    # find All  export templates
    api_response = api_instance.search_for_export_template(excludePublic=excludePublic, project=project, searchTerm=searchTerm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->search_for_export_template: %s\n" % e)

Parameters

Query parameters
Name Description
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id
searchTerm
String
search term

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateExportTemplate

edit export template


/service/private/v8/datablocks/export/templates/{templateId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/private/v8/datablocks/export/templates/{templateId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportTemplateControllerApi;

import java.io.File;
import java.util.*;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        ExportTemplateDTO body = ; // ExportTemplateDTO | exportTemplateDTO
        Long templateId = 789; // Long | templateId
        Long project = 789; // Long | Project id
        try {
            ExportTemplateDTO result = apiInstance.updateExportTemplate(body, templateId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#updateExportTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportTemplateControllerApi;

public class ExportTemplateControllerApiExample {

    public static void main(String[] args) {
        ExportTemplateControllerApi apiInstance = new ExportTemplateControllerApi();
        ExportTemplateDTO body = ; // ExportTemplateDTO | exportTemplateDTO
        Long templateId = 789; // Long | templateId
        Long project = 789; // Long | Project id
        try {
            ExportTemplateDTO result = apiInstance.updateExportTemplate(body, templateId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportTemplateControllerApi#updateExportTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExportTemplateDTO *body = ; // exportTemplateDTO
Long *templateId = 789; // templateId
Long *project = 789; // Project id (optional)

ExportTemplateControllerApi *apiInstance = [[ExportTemplateControllerApi alloc] init];

// edit  export template
[apiInstance updateExportTemplateWith:body
    templateId:templateId
    project:project
              completionHandler: ^(ExportTemplateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExportTemplateControllerApi()
var body = ; // {{ExportTemplateDTO}} exportTemplateDTO
var templateId = 789; // {{Long}} templateId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExportTemplate(bodytemplateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExportTemplateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportTemplateControllerApi();
            var body = new ExportTemplateDTO(); // ExportTemplateDTO | exportTemplateDTO
            var templateId = 789;  // Long | templateId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit  export template
                ExportTemplateDTO result = apiInstance.updateExportTemplate(body, templateId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportTemplateControllerApi.updateExportTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportTemplateControllerApi();
$body = ; // ExportTemplateDTO | exportTemplateDTO
$templateId = 789; // Long | templateId
$project = 789; // Long | Project id

try {
    $result = $api_instance->updateExportTemplate($body, $templateId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportTemplateControllerApi->updateExportTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportTemplateControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportTemplateControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExportTemplateDTO->new(); # ExportTemplateDTO | exportTemplateDTO
my $templateId = 789; # Long | templateId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->updateExportTemplate(body => $body, templateId => $templateId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportTemplateControllerApi->updateExportTemplate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportTemplateControllerApi()
body =  # ExportTemplateDTO | exportTemplateDTO
templateId = 789 # Long | templateId
project = 789 # Long | Project id (optional)

try: 
    # edit  export template
    api_response = api_instance.update_export_template(body, templateId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportTemplateControllerApi->updateExportTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
templateId*
Long (int64)
templateId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


ExposeProjectController

listAllDataExposes

List all data exposes


/service/data_exposes/projects

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/data_exposes/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExposeProjectControllerApi;

import java.io.File;
import java.util.*;

public class ExposeProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExposeProjectControllerApi apiInstance = new ExposeProjectControllerApi();
        try {
            array[ProjectsDataExpose] result = apiInstance.listAllDataExposes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeProjectControllerApi#listAllDataExposes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExposeProjectControllerApi;

public class ExposeProjectControllerApiExample {

    public static void main(String[] args) {
        ExposeProjectControllerApi apiInstance = new ExposeProjectControllerApi();
        try {
            array[ProjectsDataExpose] result = apiInstance.listAllDataExposes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeProjectControllerApi#listAllDataExposes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ExposeProjectControllerApi *apiInstance = [[ExposeProjectControllerApi alloc] init];

// List all data exposes
[apiInstance listAllDataExposesWithCompletionHandler: 
              ^(array[ProjectsDataExpose] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExposeProjectControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllDataExposes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllDataExposesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExposeProjectControllerApi();

            try
            {
                // List all data exposes
                array[ProjectsDataExpose] result = apiInstance.listAllDataExposes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExposeProjectControllerApi.listAllDataExposes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExposeProjectControllerApi();

try {
    $result = $api_instance->listAllDataExposes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExposeProjectControllerApi->listAllDataExposes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExposeProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExposeProjectControllerApi->new();

eval { 
    my $result = $api_instance->listAllDataExposes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExposeProjectControllerApi->listAllDataExposes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExposeProjectControllerApi()

try: 
    # List all data exposes
    api_response = api_instance.list_all_data_exposes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExposeProjectControllerApi->listAllDataExposes: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listAllDataExposesByProject

List all data exposes for a given project


/service/data_exposes/projects/{projectId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/data_exposes/projects/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExposeProjectControllerApi;

import java.io.File;
import java.util.*;

public class ExposeProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExposeProjectControllerApi apiInstance = new ExposeProjectControllerApi();
        Long projectId = 789; // Long | Project id
        try {
            array[ProjectDataExpose] result = apiInstance.listAllDataExposesByProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeProjectControllerApi#listAllDataExposesByProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExposeProjectControllerApi;

public class ExposeProjectControllerApiExample {

    public static void main(String[] args) {
        ExposeProjectControllerApi apiInstance = new ExposeProjectControllerApi();
        Long projectId = 789; // Long | Project id
        try {
            array[ProjectDataExpose] result = apiInstance.listAllDataExposesByProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeProjectControllerApi#listAllDataExposesByProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *projectId = 789; // Project id

ExposeProjectControllerApi *apiInstance = [[ExposeProjectControllerApi alloc] init];

// List all data exposes for a given project
[apiInstance listAllDataExposesByProjectWith:projectId
              completionHandler: ^(array[ProjectDataExpose] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExposeProjectControllerApi()
var projectId = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllDataExposesByProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllDataExposesByProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExposeProjectControllerApi();
            var projectId = 789;  // Long | Project id

            try
            {
                // List all data exposes for a given project
                array[ProjectDataExpose] result = apiInstance.listAllDataExposesByProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExposeProjectControllerApi.listAllDataExposesByProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExposeProjectControllerApi();
$projectId = 789; // Long | Project id

try {
    $result = $api_instance->listAllDataExposesByProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExposeProjectControllerApi->listAllDataExposesByProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExposeProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExposeProjectControllerApi->new();
my $projectId = 789; # Long | Project id

eval { 
    my $result = $api_instance->listAllDataExposesByProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExposeProjectControllerApi->listAllDataExposesByProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExposeProjectControllerApi()
projectId = 789 # Long | Project id

try: 
    # List all data exposes for a given project
    api_response = api_instance.list_all_data_exposes_by_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExposeProjectControllerApi->listAllDataExposesByProject: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ExposeQueryController

getDataBlockDataCountSync

Get DataBlock data count


/service/data/{name}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"//localhost:80//service/data/{name}/count?filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExposeQueryControllerApi;

import java.io.File;
import java.util.*;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String name = name_example; // String | DataBlock endpoint name
        String filter = filter_example; // String | Filter. Example : filter=name==abc or (country==france and value>=5)
        try {
            apiInstance.getDataBlockDataCountSync(name, filter);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockDataCountSync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExposeQueryControllerApi;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String name = name_example; // String | DataBlock endpoint name
        String filter = filter_example; // String | Filter. Example : filter=name==abc or (country==france and value>=5)
        try {
            apiInstance.getDataBlockDataCountSync(name, filter);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockDataCountSync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *name = name_example; // DataBlock endpoint name
String *filter = filter_example; // Filter. Example : filter=name==abc or (country==france and value>=5) (optional)

ExposeQueryControllerApi *apiInstance = [[ExposeQueryControllerApi alloc] init];

// Get DataBlock data count
[apiInstance getDataBlockDataCountSyncWith:name
    filter:filter
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExposeQueryControllerApi()
var name = name_example; // {{String}} DataBlock endpoint name
var opts = { 
  'filter': filter_example // {{String}} Filter. Example : filter=name==abc or (country==france and value>=5)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDataBlockDataCountSync(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockDataCountSyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExposeQueryControllerApi();
            var name = name_example;  // String | DataBlock endpoint name
            var filter = filter_example;  // String | Filter. Example : filter=name==abc or (country==france and value>=5) (optional) 

            try
            {
                // Get DataBlock data count
                apiInstance.getDataBlockDataCountSync(name, filter);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExposeQueryControllerApi.getDataBlockDataCountSync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExposeQueryControllerApi();
$name = name_example; // String | DataBlock endpoint name
$filter = filter_example; // String | Filter. Example : filter=name==abc or (country==france and value>=5)

try {
    $api_instance->getDataBlockDataCountSync($name, $filter);
} catch (Exception $e) {
    echo 'Exception when calling ExposeQueryControllerApi->getDataBlockDataCountSync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExposeQueryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExposeQueryControllerApi->new();
my $name = name_example; # String | DataBlock endpoint name
my $filter = filter_example; # String | Filter. Example : filter=name==abc or (country==france and value>=5)

eval { 
    $api_instance->getDataBlockDataCountSync(name => $name, filter => $filter);
};
if ($@) {
    warn "Exception when calling ExposeQueryControllerApi->getDataBlockDataCountSync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExposeQueryControllerApi()
name = name_example # String | DataBlock endpoint name
filter = filter_example # String | Filter. Example : filter=name==abc or (country==france and value>=5) (optional)

try: 
    # Get DataBlock data count
    api_instance.get_data_block_data_count_sync(name, filter=filter)
except ApiException as e:
    print("Exception when calling ExposeQueryControllerApi->getDataBlockDataCountSync: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
DataBlock endpoint name
Required
Query parameters
Name Description
filter
String
Filter. Example : filter=name==abc or (country==france and value>=5)

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockDataSync

Get DataBlock data


/service/data/{name}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"//localhost:80//service/data/{name}?filter=&hitsPerPage=&page=&select=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExposeQueryControllerApi;

import java.io.File;
import java.util.*;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String name = name_example; // String | DataBlock endpoint name
        String filter = filter_example; // String | Filter. Example : filter=name==abc or (country==france and value>=5)
        Long hitsPerPage = 789; // Long | Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results)
        Integer page = 56; // Integer | Page number
        String select = select_example; // String | Select (column names separated by Comma. Example : select=name,city,country)
        String sort = sort_example; // String | Sort (column names separated by Comma. Example : sort=name:asc,city:desc)
        try {
            apiInstance.getDataBlockDataSync(name, filter, hitsPerPage, page, select, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockDataSync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExposeQueryControllerApi;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String name = name_example; // String | DataBlock endpoint name
        String filter = filter_example; // String | Filter. Example : filter=name==abc or (country==france and value>=5)
        Long hitsPerPage = 789; // Long | Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results)
        Integer page = 56; // Integer | Page number
        String select = select_example; // String | Select (column names separated by Comma. Example : select=name,city,country)
        String sort = sort_example; // String | Sort (column names separated by Comma. Example : sort=name:asc,city:desc)
        try {
            apiInstance.getDataBlockDataSync(name, filter, hitsPerPage, page, select, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockDataSync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *name = name_example; // DataBlock endpoint name
String *filter = filter_example; // Filter. Example : filter=name==abc or (country==france and value>=5) (optional)
Long *hitsPerPage = 789; // Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results) (optional)
Integer *page = 56; // Page number (optional) (default to 1)
String *select = select_example; // Select (column names separated by Comma. Example : select=name,city,country) (optional)
String *sort = sort_example; // Sort (column names separated by Comma. Example : sort=name:asc,city:desc) (optional)

ExposeQueryControllerApi *apiInstance = [[ExposeQueryControllerApi alloc] init];

// Get DataBlock data
[apiInstance getDataBlockDataSyncWith:name
    filter:filter
    hitsPerPage:hitsPerPage
    page:page
    select:select
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExposeQueryControllerApi()
var name = name_example; // {{String}} DataBlock endpoint name
var opts = { 
  'filter': filter_example, // {{String}} Filter. Example : filter=name==abc or (country==france and value>=5)
  'hitsPerPage': 789, // {{Long}} Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results)
  'page': 56, // {{Integer}} Page number
  'select': select_example, // {{String}} Select (column names separated by Comma. Example : select=name,city,country)
  'sort': sort_example // {{String}} Sort (column names separated by Comma. Example : sort=name:asc,city:desc)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDataBlockDataSync(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockDataSyncExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExposeQueryControllerApi();
            var name = name_example;  // String | DataBlock endpoint name
            var filter = filter_example;  // String | Filter. Example : filter=name==abc or (country==france and value>=5) (optional) 
            var hitsPerPage = 789;  // Long | Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results) (optional) 
            var page = 56;  // Integer | Page number (optional)  (default to 1)
            var select = select_example;  // String | Select (column names separated by Comma. Example : select=name,city,country) (optional) 
            var sort = sort_example;  // String | Sort (column names separated by Comma. Example : sort=name:asc,city:desc) (optional) 

            try
            {
                // Get DataBlock data
                apiInstance.getDataBlockDataSync(name, filter, hitsPerPage, page, select, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExposeQueryControllerApi.getDataBlockDataSync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExposeQueryControllerApi();
$name = name_example; // String | DataBlock endpoint name
$filter = filter_example; // String | Filter. Example : filter=name==abc or (country==france and value>=5)
$hitsPerPage = 789; // Long | Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results)
$page = 56; // Integer | Page number
$select = select_example; // String | Select (column names separated by Comma. Example : select=name,city,country)
$sort = sort_example; // String | Sort (column names separated by Comma. Example : sort=name:asc,city:desc)

try {
    $api_instance->getDataBlockDataSync($name, $filter, $hitsPerPage, $page, $select, $sort);
} catch (Exception $e) {
    echo 'Exception when calling ExposeQueryControllerApi->getDataBlockDataSync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExposeQueryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExposeQueryControllerApi->new();
my $name = name_example; # String | DataBlock endpoint name
my $filter = filter_example; # String | Filter. Example : filter=name==abc or (country==france and value>=5)
my $hitsPerPage = 789; # Long | Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results)
my $page = 56; # Integer | Page number
my $select = select_example; # String | Select (column names separated by Comma. Example : select=name,city,country)
my $sort = sort_example; # String | Sort (column names separated by Comma. Example : sort=name:asc,city:desc)

eval { 
    $api_instance->getDataBlockDataSync(name => $name, filter => $filter, hitsPerPage => $hitsPerPage, page => $page, select => $select, sort => $sort);
};
if ($@) {
    warn "Exception when calling ExposeQueryControllerApi->getDataBlockDataSync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExposeQueryControllerApi()
name = name_example # String | DataBlock endpoint name
filter = filter_example # String | Filter. Example : filter=name==abc or (country==france and value>=5) (optional)
hitsPerPage = 789 # Long | Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results) (optional)
page = 56 # Integer | Page number (optional) (default to 1)
select = select_example # String | Select (column names separated by Comma. Example : select=name,city,country) (optional)
sort = sort_example # String | Sort (column names separated by Comma. Example : sort=name:asc,city:desc) (optional)

try: 
    # Get DataBlock data
    api_instance.get_data_block_data_sync(name, filter=filter, hitsPerPage=hitsPerPage, page=page, select=select, sort=sort)
except ApiException as e:
    print("Exception when calling ExposeQueryControllerApi->getDataBlockDataSync: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
DataBlock endpoint name
Required
Query parameters
Name Description
filter
String
Filter. Example : filter=name==abc or (country==france and value>=5)
hitsPerPage
Long (int64)
Page number of items per page (max = 100000 per default, but this default value may have been overwritten with application configuration (dc.app.expose.api.max-results)
page
Integer (int32)
Page number
select
String
Select (column names separated by Comma. Example : select=name,city,country)
sort
String
Sort (column names separated by Comma. Example : sort=name:asc,city:desc)

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockInfo

Get DataBlock data infos


/service/data/{name}/info

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/data/{name}/info"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExposeQueryControllerApi;

import java.io.File;
import java.util.*;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String name = name_example; // String | DataBlock endpoint name
        try {
            DataExposeInfo result = apiInstance.getDataBlockInfo(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExposeQueryControllerApi;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String name = name_example; // String | DataBlock endpoint name
        try {
            DataExposeInfo result = apiInstance.getDataBlockInfo(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *name = name_example; // DataBlock endpoint name

ExposeQueryControllerApi *apiInstance = [[ExposeQueryControllerApi alloc] init];

// Get DataBlock data infos
[apiInstance getDataBlockInfoWith:name
              completionHandler: ^(DataExposeInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExposeQueryControllerApi()
var name = name_example; // {{String}} DataBlock endpoint name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataBlockInfo(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockInfoExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExposeQueryControllerApi();
            var name = name_example;  // String | DataBlock endpoint name

            try
            {
                // Get DataBlock data infos
                DataExposeInfo result = apiInstance.getDataBlockInfo(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExposeQueryControllerApi.getDataBlockInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExposeQueryControllerApi();
$name = name_example; // String | DataBlock endpoint name

try {
    $result = $api_instance->getDataBlockInfo($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExposeQueryControllerApi->getDataBlockInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExposeQueryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExposeQueryControllerApi->new();
my $name = name_example; # String | DataBlock endpoint name

eval { 
    my $result = $api_instance->getDataBlockInfo(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExposeQueryControllerApi->getDataBlockInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExposeQueryControllerApi()
name = name_example # String | DataBlock endpoint name

try: 
    # Get DataBlock data infos
    api_response = api_instance.get_data_block_info(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExposeQueryControllerApi->getDataBlockInfo: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
DataBlock endpoint name
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDataBlockItem

Get DataBlock data item


/service/data/{name}/items/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"//localhost:80//service/data/{name}/items/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExposeQueryControllerApi;

import java.io.File;
import java.util.*;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String id = id_example; // String | Item id
        String name = name_example; // String | DataBlock endpoint name
        try {
            apiInstance.getDataBlockItem(id, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExposeQueryControllerApi;

public class ExposeQueryControllerApiExample {

    public static void main(String[] args) {
        ExposeQueryControllerApi apiInstance = new ExposeQueryControllerApi();
        String id = id_example; // String | Item id
        String name = name_example; // String | DataBlock endpoint name
        try {
            apiInstance.getDataBlockItem(id, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExposeQueryControllerApi#getDataBlockItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Item id
String *name = name_example; // DataBlock endpoint name

ExposeQueryControllerApi *apiInstance = [[ExposeQueryControllerApi alloc] init];

// Get DataBlock data item
[apiInstance getDataBlockItemWith:id
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ExposeQueryControllerApi()
var id = id_example; // {{String}} Item id
var name = name_example; // {{String}} DataBlock endpoint name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDataBlockItem(id, name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataBlockItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExposeQueryControllerApi();
            var id = id_example;  // String | Item id
            var name = name_example;  // String | DataBlock endpoint name

            try
            {
                // Get DataBlock data item
                apiInstance.getDataBlockItem(id, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExposeQueryControllerApi.getDataBlockItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExposeQueryControllerApi();
$id = id_example; // String | Item id
$name = name_example; // String | DataBlock endpoint name

try {
    $api_instance->getDataBlockItem($id, $name);
} catch (Exception $e) {
    echo 'Exception when calling ExposeQueryControllerApi->getDataBlockItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExposeQueryControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExposeQueryControllerApi->new();
my $id = id_example; # String | Item id
my $name = name_example; # String | DataBlock endpoint name

eval { 
    $api_instance->getDataBlockItem(id => $id, name => $name);
};
if ($@) {
    warn "Exception when calling ExposeQueryControllerApi->getDataBlockItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExposeQueryControllerApi()
id = id_example # String | Item id
name = name_example # String | DataBlock endpoint name

try: 
    # Get DataBlock data item
    api_instance.get_data_block_item(id, name)
except ApiException as e:
    print("Exception when calling ExposeQueryControllerApi->getDataBlockItem: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Item id
Required
name*
String
DataBlock endpoint name
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


FileDownloadController

downloadFileByToken

Download File by token


/service/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileDownloadControllerApi;

import java.io.File;
import java.util.*;

public class FileDownloadControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FileDownloadControllerApi apiInstance = new FileDownloadControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadFileByToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileDownloadControllerApi#downloadFileByToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileDownloadControllerApi;

public class FileDownloadControllerApiExample {

    public static void main(String[] args) {
        FileDownloadControllerApi apiInstance = new FileDownloadControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadFileByToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileDownloadControllerApi#downloadFileByToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

FileDownloadControllerApi *apiInstance = [[FileDownloadControllerApi alloc] init];

// Download File by token
[apiInstance downloadFileByTokenWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FileDownloadControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadFileByToken(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadFileByTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FileDownloadControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download File by token
                apiInstance.downloadFileByToken(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileDownloadControllerApi.downloadFileByToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFileDownloadControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadFileByToken($token);
} catch (Exception $e) {
    echo 'Exception when calling FileDownloadControllerApi->downloadFileByToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileDownloadControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FileDownloadControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadFileByToken(token => $token);
};
if ($@) {
    warn "Exception when calling FileDownloadControllerApi->downloadFileByToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FileDownloadControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download File by token
    api_instance.download_file_by_token(token=token)
except ApiException as e:
    print("Exception when calling FileDownloadControllerApi->downloadFileByToken: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getFileDownloadToken

get Download file by path token


/service/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/file/token?ctx=&filePath=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileDownloadControllerApi;

import java.io.File;
import java.util.*;

public class FileDownloadControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FileDownloadControllerApi apiInstance = new FileDownloadControllerApi();
        Integer ctx = 56; // Integer | ctx
        String filePath = filePath_example; // String | filePath
        String type = type_example; // String | type
        try {
            'String' result = apiInstance.getFileDownloadToken(ctx, filePath, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileDownloadControllerApi#getFileDownloadToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileDownloadControllerApi;

public class FileDownloadControllerApiExample {

    public static void main(String[] args) {
        FileDownloadControllerApi apiInstance = new FileDownloadControllerApi();
        Integer ctx = 56; // Integer | ctx
        String filePath = filePath_example; // String | filePath
        String type = type_example; // String | type
        try {
            'String' result = apiInstance.getFileDownloadToken(ctx, filePath, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileDownloadControllerApi#getFileDownloadToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *filePath = filePath_example; // filePath
String *type = type_example; // type

FileDownloadControllerApi *apiInstance = [[FileDownloadControllerApi alloc] init];

// get Download file by path token
[apiInstance getFileDownloadTokenWith:ctx
    filePath:filePath
    type:type
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FileDownloadControllerApi()
var ctx = 56; // {{Integer}} ctx
var filePath = filePath_example; // {{String}} filePath
var type = type_example; // {{String}} type

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFileDownloadToken(ctx, filePath, type, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFileDownloadTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FileDownloadControllerApi();
            var ctx = 56;  // Integer | ctx
            var filePath = filePath_example;  // String | filePath
            var type = type_example;  // String | type

            try
            {
                // get Download file by path token
                'String' result = apiInstance.getFileDownloadToken(ctx, filePath, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileDownloadControllerApi.getFileDownloadToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFileDownloadControllerApi();
$ctx = 56; // Integer | ctx
$filePath = filePath_example; // String | filePath
$type = type_example; // String | type

try {
    $result = $api_instance->getFileDownloadToken($ctx, $filePath, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileDownloadControllerApi->getFileDownloadToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileDownloadControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FileDownloadControllerApi->new();
my $ctx = 56; # Integer | ctx
my $filePath = filePath_example; # String | filePath
my $type = type_example; # String | type

eval { 
    my $result = $api_instance->getFileDownloadToken(ctx => $ctx, filePath => $filePath, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileDownloadControllerApi->getFileDownloadToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FileDownloadControllerApi()
ctx = 56 # Integer | ctx
filePath = filePath_example # String | filePath
type = type_example # String | type

try: 
    # get Download file by path token
    api_response = api_instance.get_file_download_token(ctx, filePath, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileDownloadControllerApi->getFileDownloadToken: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filePath*
String
filePath
Required
type*
String
type
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


FormulaCatalogController

countAllFormulaCatalogItems

countAllFormulaCatalogItems


/service/formula_catalog/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/formula_catalog/count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        try {
            Long result = apiInstance.countAllFormulaCatalogItems();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#countAllFormulaCatalogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        try {
            Long result = apiInstance.countAllFormulaCatalogItems();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#countAllFormulaCatalogItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// countAllFormulaCatalogItems
[apiInstance countAllFormulaCatalogItemsWithCompletionHandler: 
              ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.countAllFormulaCatalogItems(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class countAllFormulaCatalogItemsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();

            try
            {
                // countAllFormulaCatalogItems
                Long result = apiInstance.countAllFormulaCatalogItems();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.countAllFormulaCatalogItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();

try {
    $result = $api_instance->countAllFormulaCatalogItems();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->countAllFormulaCatalogItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();

eval { 
    my $result = $api_instance->countAllFormulaCatalogItems();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->countAllFormulaCatalogItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()

try: 
    # countAllFormulaCatalogItems
    api_response = api_instance.count_all_formula_catalog_items()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->countAllFormulaCatalogItems: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createFormulaCatalogItem

createFormulaCatalogItem


/service/formula_catalog

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/formula_catalog?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        FormulaCatalogItem body = ; // FormulaCatalogItem | formulaCatalogItem
        Long project = 789; // Long | Project id
        try {
            FormulaCatalogItem result = apiInstance.createFormulaCatalogItem(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#createFormulaCatalogItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        FormulaCatalogItem body = ; // FormulaCatalogItem | formulaCatalogItem
        Long project = 789; // Long | Project id
        try {
            FormulaCatalogItem result = apiInstance.createFormulaCatalogItem(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#createFormulaCatalogItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
FormulaCatalogItem *body = ; // formulaCatalogItem
Long *project = 789; // Project id (optional)

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// createFormulaCatalogItem
[apiInstance createFormulaCatalogItemWith:body
    project:project
              completionHandler: ^(FormulaCatalogItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var body = ; // {{FormulaCatalogItem}} formulaCatalogItem
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFormulaCatalogItem(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFormulaCatalogItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var body = new FormulaCatalogItem(); // FormulaCatalogItem | formulaCatalogItem
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // createFormulaCatalogItem
                FormulaCatalogItem result = apiInstance.createFormulaCatalogItem(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.createFormulaCatalogItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$body = ; // FormulaCatalogItem | formulaCatalogItem
$project = 789; // Long | Project id

try {
    $result = $api_instance->createFormulaCatalogItem($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->createFormulaCatalogItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $body = WWW::SwaggerClient::Object::FormulaCatalogItem->new(); # FormulaCatalogItem | formulaCatalogItem
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createFormulaCatalogItem(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->createFormulaCatalogItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
body =  # FormulaCatalogItem | formulaCatalogItem
project = 789 # Long | Project id (optional)

try: 
    # createFormulaCatalogItem
    api_response = api_instance.create_formula_catalog_item(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->createFormulaCatalogItem: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteFormulaCatalogItem

delete Formula Catalog Item


/service/formula_catalog/{itemId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/formula_catalog/{itemId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long itemId = 789; // Long | itemId
        try {
            apiInstance.deleteFormulaCatalogItem(itemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#deleteFormulaCatalogItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long itemId = 789; // Long | itemId
        try {
            apiInstance.deleteFormulaCatalogItem(itemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#deleteFormulaCatalogItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *itemId = 789; // itemId

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// delete Formula Catalog Item
[apiInstance deleteFormulaCatalogItemWith:itemId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var itemId = 789; // {{Long}} itemId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFormulaCatalogItem(itemId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFormulaCatalogItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var itemId = 789;  // Long | itemId

            try
            {
                // delete Formula Catalog Item
                apiInstance.deleteFormulaCatalogItem(itemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.deleteFormulaCatalogItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$itemId = 789; // Long | itemId

try {
    $api_instance->deleteFormulaCatalogItem($itemId);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->deleteFormulaCatalogItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $itemId = 789; # Long | itemId

eval { 
    $api_instance->deleteFormulaCatalogItem(itemId => $itemId);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->deleteFormulaCatalogItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
itemId = 789 # Long | itemId

try: 
    # delete Formula Catalog Item
    api_instance.delete_formula_catalog_item(itemId)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->deleteFormulaCatalogItem: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Long (int64)
itemId
Required

Responses

Status: 200 - OK


deleteFormulaCatalogItems

delete Formula Catalog Items


/service/formula_catalog

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/formula_catalog?itemsIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        array[Long] itemsIds = ; // array[Long] | itemsIds
        try {
            apiInstance.deleteFormulaCatalogItems(itemsIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#deleteFormulaCatalogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        array[Long] itemsIds = ; // array[Long] | itemsIds
        try {
            apiInstance.deleteFormulaCatalogItems(itemsIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#deleteFormulaCatalogItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *itemsIds = ; // itemsIds

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// delete Formula Catalog Items
[apiInstance deleteFormulaCatalogItemsWith:itemsIds
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var itemsIds = ; // {{array[Long]}} itemsIds

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFormulaCatalogItems(itemsIds, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFormulaCatalogItemsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var itemsIds = new array[Long](); // array[Long] | itemsIds

            try
            {
                // delete Formula Catalog Items
                apiInstance.deleteFormulaCatalogItems(itemsIds);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.deleteFormulaCatalogItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$itemsIds = ; // array[Long] | itemsIds

try {
    $api_instance->deleteFormulaCatalogItems($itemsIds);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->deleteFormulaCatalogItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $itemsIds = []; # array[Long] | itemsIds

eval { 
    $api_instance->deleteFormulaCatalogItems(itemsIds => $itemsIds);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->deleteFormulaCatalogItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
itemsIds =  # array[Long] | itemsIds

try: 
    # delete Formula Catalog Items
    api_instance.delete_formula_catalog_items(itemsIds)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->deleteFormulaCatalogItems: %s\n" % e)

Parameters

Query parameters
Name Description
itemsIds*
array[Long] (int64)
itemsIds
Required

Responses

Status: 200 - OK


duplicationFormulaCatalogItemById

duplicationFormulaCatalogItemById


/service/formula_catalog/{itemId}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/formula_catalog/{itemId}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long itemId = 789; // Long | itemId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            FormulaCatalogItem result = apiInstance.duplicationFormulaCatalogItemById(itemId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#duplicationFormulaCatalogItemById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long itemId = 789; // Long | itemId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            FormulaCatalogItem result = apiInstance.duplicationFormulaCatalogItemById(itemId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#duplicationFormulaCatalogItemById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *itemId = 789; // itemId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// duplicationFormulaCatalogItemById
[apiInstance duplicationFormulaCatalogItemByIdWith:itemId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(FormulaCatalogItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var itemId = 789; // {{Long}} itemId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicationFormulaCatalogItemById(itemId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicationFormulaCatalogItemByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var itemId = 789;  // Long | itemId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // duplicationFormulaCatalogItemById
                FormulaCatalogItem result = apiInstance.duplicationFormulaCatalogItemById(itemId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.duplicationFormulaCatalogItemById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$itemId = 789; // Long | itemId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicationFormulaCatalogItemById($itemId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->duplicationFormulaCatalogItemById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $itemId = 789; # Long | itemId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicationFormulaCatalogItemById(itemId => $itemId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->duplicationFormulaCatalogItemById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
itemId = 789 # Long | itemId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # duplicationFormulaCatalogItemById
    api_response = api_instance.duplication_formula_catalog_item_by_id(itemId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->duplicationFormulaCatalogItemById: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Long (int64)
itemId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllFormulaCatalogItems

findAllFormulaCatalogItems


/service/formula_catalog

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/formula_catalog?excludeInactive=&shared="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean shared = true; // Boolean | Include shared
        try {
            array[FormulaCatalogItem] result = apiInstance.findAllFormulaCatalogItems(excludeInactive, shared);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#findAllFormulaCatalogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean shared = true; // Boolean | Include shared
        try {
            array[FormulaCatalogItem] result = apiInstance.findAllFormulaCatalogItems(excludeInactive, shared);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#findAllFormulaCatalogItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *shared = true; // Include shared (optional)

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// findAllFormulaCatalogItems
[apiInstance findAllFormulaCatalogItemsWith:excludeInactive
    shared:shared
              completionHandler: ^(array[FormulaCatalogItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'shared': true // {{Boolean}} Include shared
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllFormulaCatalogItems(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllFormulaCatalogItemsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var shared = true;  // Boolean | Include shared (optional) 

            try
            {
                // findAllFormulaCatalogItems
                array[FormulaCatalogItem] result = apiInstance.findAllFormulaCatalogItems(excludeInactive, shared);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.findAllFormulaCatalogItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$shared = true; // Boolean | Include shared

try {
    $result = $api_instance->findAllFormulaCatalogItems($excludeInactive, $shared);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->findAllFormulaCatalogItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $shared = true; # Boolean | Include shared

eval { 
    my $result = $api_instance->findAllFormulaCatalogItems(excludeInactive => $excludeInactive, shared => $shared);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->findAllFormulaCatalogItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
shared = true # Boolean | Include shared (optional)

try: 
    # findAllFormulaCatalogItems
    api_response = api_instance.find_all_formula_catalog_items(excludeInactive=excludeInactive, shared=shared)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->findAllFormulaCatalogItems: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
shared
Boolean
Include shared

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleFileUploadForExpressIntegration

handleFileUploadForExpressIntegration


/service/formula_catalog/import/upload

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/formula_catalog/import/upload?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long project = 789; // Long | Project id
        try {
            FormulaCatalogImport result = apiInstance.handleFileUploadForExpressIntegration(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#handleFileUploadForExpressIntegration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long project = 789; // Long | Project id
        try {
            FormulaCatalogImport result = apiInstance.handleFileUploadForExpressIntegration(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#handleFileUploadForExpressIntegration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// handleFileUploadForExpressIntegration
[apiInstance handleFileUploadForExpressIntegrationWith:project
              completionHandler: ^(FormulaCatalogImport output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleFileUploadForExpressIntegration(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleFileUploadForExpressIntegrationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // handleFileUploadForExpressIntegration
                FormulaCatalogImport result = apiInstance.handleFileUploadForExpressIntegration(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.handleFileUploadForExpressIntegration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleFileUploadForExpressIntegration($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->handleFileUploadForExpressIntegration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleFileUploadForExpressIntegration(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->handleFileUploadForExpressIntegration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # handleFileUploadForExpressIntegration
    api_response = api_instance.handle_file_upload_for_express_integration(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->handleFileUploadForExpressIntegration: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


integrateImportedElements

integrateImportedElements


/service/formula_catalog/import/integrate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/formula_catalog/import/integrate?importId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        String importId = importId_example; // String | importId
        Long project = 789; // Long | Project id
        try {
            array[FormulaCatalogItem] result = apiInstance.integrateImportedElements(importId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#integrateImportedElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        String importId = importId_example; // String | importId
        Long project = 789; // Long | Project id
        try {
            array[FormulaCatalogItem] result = apiInstance.integrateImportedElements(importId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#integrateImportedElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *importId = importId_example; // importId
Long *project = 789; // Project id (optional)

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// integrateImportedElements
[apiInstance integrateImportedElementsWith:importId
    project:project
              completionHandler: ^(array[FormulaCatalogItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var importId = importId_example; // {{String}} importId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.integrateImportedElements(importId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class integrateImportedElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var importId = importId_example;  // String | importId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // integrateImportedElements
                array[FormulaCatalogItem] result = apiInstance.integrateImportedElements(importId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.integrateImportedElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$importId = importId_example; // String | importId
$project = 789; // Long | Project id

try {
    $result = $api_instance->integrateImportedElements($importId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->integrateImportedElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $importId = importId_example; # String | importId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->integrateImportedElements(importId => $importId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->integrateImportedElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
importId = importId_example # String | importId
project = 789 # Long | Project id (optional)

try: 
    # integrateImportedElements
    api_response = api_instance.integrate_imported_elements(importId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->integrateImportedElements: %s\n" % e)

Parameters

Query parameters
Name Description
importId*
String
importId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateFormulaCatalogItem

updateFormulaCatalogItem


/service/formula_catalog/{itemId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/formula_catalog/{itemId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        FormulaCatalogItem body = ; // FormulaCatalogItem | formulaCatalogItem
        Long itemId = 789; // Long | itemId
        Long project = 789; // Long | Project id
        try {
            FormulaCatalogItem result = apiInstance.updateFormulaCatalogItem(body, itemId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#updateFormulaCatalogItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        FormulaCatalogItem body = ; // FormulaCatalogItem | formulaCatalogItem
        Long itemId = 789; // Long | itemId
        Long project = 789; // Long | Project id
        try {
            FormulaCatalogItem result = apiInstance.updateFormulaCatalogItem(body, itemId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#updateFormulaCatalogItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
FormulaCatalogItem *body = ; // formulaCatalogItem
Long *itemId = 789; // itemId
Long *project = 789; // Project id (optional)

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// updateFormulaCatalogItem
[apiInstance updateFormulaCatalogItemWith:body
    itemId:itemId
    project:project
              completionHandler: ^(FormulaCatalogItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var body = ; // {{FormulaCatalogItem}} formulaCatalogItem
var itemId = 789; // {{Long}} itemId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFormulaCatalogItem(bodyitemId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateFormulaCatalogItemExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var body = new FormulaCatalogItem(); // FormulaCatalogItem | formulaCatalogItem
            var itemId = 789;  // Long | itemId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // updateFormulaCatalogItem
                FormulaCatalogItem result = apiInstance.updateFormulaCatalogItem(body, itemId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.updateFormulaCatalogItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$body = ; // FormulaCatalogItem | formulaCatalogItem
$itemId = 789; // Long | itemId
$project = 789; // Long | Project id

try {
    $result = $api_instance->updateFormulaCatalogItem($body, $itemId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->updateFormulaCatalogItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $body = WWW::SwaggerClient::Object::FormulaCatalogItem->new(); # FormulaCatalogItem | formulaCatalogItem
my $itemId = 789; # Long | itemId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->updateFormulaCatalogItem(body => $body, itemId => $itemId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->updateFormulaCatalogItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
body =  # FormulaCatalogItem | formulaCatalogItem
itemId = 789 # Long | itemId
project = 789 # Long | Project id (optional)

try: 
    # updateFormulaCatalogItem
    api_response = api_instance.update_formula_catalog_item(body, itemId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->updateFormulaCatalogItem: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Long (int64)
itemId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateFormulaSharedStatus

updateFormulaSharedStatus


/service/formula_catalog/{itemId}/status

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
"//localhost:80//service/formula_catalog/{itemId}/status?shared="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormulaCatalogControllerApi;

import java.io.File;
import java.util.*;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long itemId = 789; // Long | itemId
        Boolean shared = true; // Boolean | shared
        try {
            FormulaCatalogItem result = apiInstance.updateFormulaSharedStatus(itemId, shared);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#updateFormulaSharedStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormulaCatalogControllerApi;

public class FormulaCatalogControllerApiExample {

    public static void main(String[] args) {
        FormulaCatalogControllerApi apiInstance = new FormulaCatalogControllerApi();
        Long itemId = 789; // Long | itemId
        Boolean shared = true; // Boolean | shared
        try {
            FormulaCatalogItem result = apiInstance.updateFormulaSharedStatus(itemId, shared);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormulaCatalogControllerApi#updateFormulaSharedStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *itemId = 789; // itemId
Boolean *shared = true; // shared

FormulaCatalogControllerApi *apiInstance = [[FormulaCatalogControllerApi alloc] init];

// updateFormulaSharedStatus
[apiInstance updateFormulaSharedStatusWith:itemId
    shared:shared
              completionHandler: ^(FormulaCatalogItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormulaCatalogControllerApi()
var itemId = 789; // {{Long}} itemId
var shared = true; // {{Boolean}} shared

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFormulaSharedStatus(itemId, shared, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateFormulaSharedStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormulaCatalogControllerApi();
            var itemId = 789;  // Long | itemId
            var shared = true;  // Boolean | shared

            try
            {
                // updateFormulaSharedStatus
                FormulaCatalogItem result = apiInstance.updateFormulaSharedStatus(itemId, shared);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormulaCatalogControllerApi.updateFormulaSharedStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormulaCatalogControllerApi();
$itemId = 789; // Long | itemId
$shared = true; // Boolean | shared

try {
    $result = $api_instance->updateFormulaSharedStatus($itemId, $shared);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormulaCatalogControllerApi->updateFormulaSharedStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormulaCatalogControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormulaCatalogControllerApi->new();
my $itemId = 789; # Long | itemId
my $shared = true; # Boolean | shared

eval { 
    my $result = $api_instance->updateFormulaSharedStatus(itemId => $itemId, shared => $shared);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormulaCatalogControllerApi->updateFormulaSharedStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormulaCatalogControllerApi()
itemId = 789 # Long | itemId
shared = true # Boolean | shared

try: 
    # updateFormulaSharedStatus
    api_response = api_instance.update_formula_shared_status(itemId, shared)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormulaCatalogControllerApi->updateFormulaSharedStatus: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Long (int64)
itemId
Required
Query parameters
Name Description
shared*
Boolean
shared
Required

Responses

Status: 200 - OK


FormuleController

getAllAvailableFormulas

Get list of all available formulas


/service/constants/formulas

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/constants/formulas?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormuleControllerApi;

import java.io.File;
import java.util.*;

public class FormuleControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormuleControllerApi apiInstance = new FormuleControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Formules result = apiInstance.getAllAvailableFormulas(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormuleControllerApi#getAllAvailableFormulas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormuleControllerApi;

public class FormuleControllerApiExample {

    public static void main(String[] args) {
        FormuleControllerApi apiInstance = new FormuleControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Formules result = apiInstance.getAllAvailableFormulas(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormuleControllerApi#getAllAvailableFormulas");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

FormuleControllerApi *apiInstance = [[FormuleControllerApi alloc] init];

// Get list of all available formulas
[apiInstance getAllAvailableFormulasWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Formules output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormuleControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAvailableFormulas(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllAvailableFormulasExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormuleControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get list of all available formulas
                Formules result = apiInstance.getAllAvailableFormulas(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormuleControllerApi.getAllAvailableFormulas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormuleControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getAllAvailableFormulas($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormuleControllerApi->getAllAvailableFormulas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormuleControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormuleControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getAllAvailableFormulas(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormuleControllerApi->getAllAvailableFormulas: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormuleControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get list of all available formulas
    api_response = api_instance.get_all_available_formulas(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormuleControllerApi->getAllAvailableFormulas: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getFormulaUsage

Get list of DC core elements that use a given formula


/service/formulas/usages

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/formulas/usages?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormuleControllerApi;

import java.io.File;
import java.util.*;

public class FormuleControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FormuleControllerApi apiInstance = new FormuleControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[FormulaUsage] result = apiInstance.getFormulaUsage(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormuleControllerApi#getFormulaUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormuleControllerApi;

public class FormuleControllerApiExample {

    public static void main(String[] args) {
        FormuleControllerApi apiInstance = new FormuleControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[FormulaUsage] result = apiInstance.getFormulaUsage(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormuleControllerApi#getFormulaUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

FormuleControllerApi *apiInstance = [[FormuleControllerApi alloc] init];

// Get list of DC core elements that use a given formula
[apiInstance getFormulaUsageWith:project
              completionHandler: ^(array[FormulaUsage] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FormuleControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFormulaUsage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFormulaUsageExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FormuleControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get list of DC core elements that use a given formula
                array[FormulaUsage] result = apiInstance.getFormulaUsage(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormuleControllerApi.getFormulaUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFormuleControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->getFormulaUsage($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormuleControllerApi->getFormulaUsage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormuleControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FormuleControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getFormulaUsage(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormuleControllerApi->getFormulaUsage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FormuleControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # Get list of DC core elements that use a given formula
    api_response = api_instance.get_formula_usage(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormuleControllerApi->getFormulaUsage: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


FunnelChartController

checkConfigUsingGET1

Check the configuration informations of an existing chart


/service/charts/funnel/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/funnel/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#checkConfigUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#checkConfigUsingGET1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET1With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET1(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET1(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.checkConfigUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET1($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->checkConfigUsingGET1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET1(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->checkConfigUsingGET1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get1(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->checkConfigUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createFunnelChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/funnel

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/funnel?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFunnelChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#createFunnelChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFunnelChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#createFunnelChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Create a new chart
[apiInstance createFunnelChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFunnelChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFunnelChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createFunnelChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.createFunnelChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createFunnelChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->createFunnelChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createFunnelChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->createFunnelChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_funnel_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->createFunnelChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createFunnelChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/funnel/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/funnel/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFunnelChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#createFunnelChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFunnelChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#createFunnelChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createFunnelChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFunnelChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFunnelChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createFunnelChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.createFunnelChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createFunnelChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->createFunnelChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createFunnelChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->createFunnelChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_funnel_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->createFunnelChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteFunnelChart

Delete an existing chart


/service/charts/funnel/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/funnel/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteFunnelChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#deleteFunnelChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteFunnelChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#deleteFunnelChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteFunnelChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFunnelChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFunnelChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteFunnelChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.deleteFunnelChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteFunnelChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->deleteFunnelChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteFunnelChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->deleteFunnelChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_funnel_chart(id, project=project)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->deleteFunnelChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateFunnelChart

Duplicate an existing chart


/service/charts/funnel/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/funnel/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateFunnelChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#duplicateFunnelChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateFunnelChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#duplicateFunnelChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateFunnelChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateFunnelChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateFunnelChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateFunnelChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.duplicateFunnelChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateFunnelChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->duplicateFunnelChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateFunnelChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->duplicateFunnelChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_funnel_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->duplicateFunnelChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editFunnelChart

Edit chart

Edit an existing chart


/service/charts/funnel/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/funnel/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editFunnelChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#editFunnelChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editFunnelChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#editFunnelChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Edit chart
[apiInstance editFunnelChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editFunnelChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editFunnelChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editFunnelChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.editFunnelChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editFunnelChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->editFunnelChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editFunnelChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->editFunnelChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_funnel_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->editFunnelChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editFunnelChartConfig

Update the configuration informations of an existing chart


/service/charts/funnel/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/funnel/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        UpdateFunnelChartConfigEntry body = ; // UpdateFunnelChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editFunnelChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#editFunnelChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        UpdateFunnelChartConfigEntry body = ; // UpdateFunnelChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editFunnelChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#editFunnelChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateFunnelChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editFunnelChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var body = ; // {{UpdateFunnelChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editFunnelChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editFunnelChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var body = new UpdateFunnelChartConfigEntry(); // UpdateFunnelChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editFunnelChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.editFunnelChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$body = ; // UpdateFunnelChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editFunnelChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->editFunnelChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateFunnelChartConfigEntry->new(); # UpdateFunnelChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editFunnelChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->editFunnelChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
body =  # UpdateFunnelChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_funnel_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->editFunnelChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getFunnelChart

Get a chart by Id


/service/charts/funnel/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/funnel/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getFunnelChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#getFunnelChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getFunnelChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#getFunnelChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getFunnelChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFunnelChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFunnelChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getFunnelChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.getFunnelChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getFunnelChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->getFunnelChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getFunnelChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->getFunnelChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_funnel_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->getFunnelChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getFunnelChartConfig

Get the configuration informations of an existing chart


/service/charts/funnel/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/funnel/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FunnelChartControllerApi;

import java.io.File;
import java.util.*;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            FunnelChartConfig result = apiInstance.getFunnelChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#getFunnelChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FunnelChartControllerApi;

public class FunnelChartControllerApiExample {

    public static void main(String[] args) {
        FunnelChartControllerApi apiInstance = new FunnelChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            FunnelChartConfig result = apiInstance.getFunnelChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FunnelChartControllerApi#getFunnelChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

FunnelChartControllerApi *apiInstance = [[FunnelChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getFunnelChartConfigWith:id
    project:project
              completionHandler: ^(FunnelChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.FunnelChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFunnelChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFunnelChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FunnelChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                FunnelChartConfig result = apiInstance.getFunnelChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FunnelChartControllerApi.getFunnelChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFunnelChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getFunnelChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FunnelChartControllerApi->getFunnelChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FunnelChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FunnelChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getFunnelChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FunnelChartControllerApi->getFunnelChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FunnelChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_funnel_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelChartControllerApi->getFunnelChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


GaugeBarChartController

checkConfigUsingGET2

Check the configuration informations of an existing chart


/service/charts/gauge_bar/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_bar/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET2(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#checkConfigUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET2(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#checkConfigUsingGET2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET2With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET2(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET2Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET2(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.checkConfigUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET2($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->checkConfigUsingGET2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET2(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->checkConfigUsingGET2: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get2(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->checkConfigUsingGET2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createGaugeBarChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/gauge_bar

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_bar?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeBarChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#createGaugeBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeBarChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#createGaugeBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Create a new chart
[apiInstance createGaugeBarChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGaugeBarChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGaugeBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createGaugeBarChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.createGaugeBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createGaugeBarChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->createGaugeBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createGaugeBarChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->createGaugeBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_gauge_bar_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->createGaugeBarChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createGaugeBarChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/gauge_bar/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_bar/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeBarChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#createGaugeBarChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeBarChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#createGaugeBarChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createGaugeBarChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGaugeBarChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGaugeBarChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createGaugeBarChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.createGaugeBarChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createGaugeBarChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->createGaugeBarChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createGaugeBarChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->createGaugeBarChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_gauge_bar_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->createGaugeBarChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteGaugeBarChart

Delete an existing chart


/service/charts/gauge_bar/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/gauge_bar/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteGaugeBarChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#deleteGaugeBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteGaugeBarChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#deleteGaugeBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteGaugeBarChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteGaugeBarChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteGaugeBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteGaugeBarChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.deleteGaugeBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteGaugeBarChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->deleteGaugeBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteGaugeBarChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->deleteGaugeBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_gauge_bar_chart(id, project=project)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->deleteGaugeBarChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateGaugeBarChart

Duplicate an existing chart


/service/charts/gauge_bar/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_bar/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateGaugeBarChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#duplicateGaugeBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateGaugeBarChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#duplicateGaugeBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateGaugeBarChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateGaugeBarChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateGaugeBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateGaugeBarChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.duplicateGaugeBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateGaugeBarChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->duplicateGaugeBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateGaugeBarChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->duplicateGaugeBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_gauge_bar_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->duplicateGaugeBarChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editGaugeBarChart

Edit chart

Edit an existing chart


/service/charts/gauge_bar/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_bar/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeBarChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#editGaugeBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeBarChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#editGaugeBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Edit chart
[apiInstance editGaugeBarChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGaugeBarChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGaugeBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editGaugeBarChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.editGaugeBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editGaugeBarChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->editGaugeBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editGaugeBarChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->editGaugeBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_gauge_bar_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->editGaugeBarChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editGaugeBarChartConfig

Update the configuration informations of an existing chart


/service/charts/gauge_bar/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_bar/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        UpdateGaugeBarChartConfigEntry body = ; // UpdateGaugeBarChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeBarChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#editGaugeBarChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        UpdateGaugeBarChartConfigEntry body = ; // UpdateGaugeBarChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeBarChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#editGaugeBarChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateGaugeBarChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editGaugeBarChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var body = ; // {{UpdateGaugeBarChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGaugeBarChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGaugeBarChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var body = new UpdateGaugeBarChartConfigEntry(); // UpdateGaugeBarChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editGaugeBarChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.editGaugeBarChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$body = ; // UpdateGaugeBarChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editGaugeBarChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->editGaugeBarChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateGaugeBarChartConfigEntry->new(); # UpdateGaugeBarChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editGaugeBarChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->editGaugeBarChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
body =  # UpdateGaugeBarChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_gauge_bar_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->editGaugeBarChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getGaugeBarChart

Get a chart by Id


/service/charts/gauge_bar/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_bar/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getGaugeBarChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#getGaugeBarChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getGaugeBarChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#getGaugeBarChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getGaugeBarChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGaugeBarChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGaugeBarChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getGaugeBarChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.getGaugeBarChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGaugeBarChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->getGaugeBarChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGaugeBarChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->getGaugeBarChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_gauge_bar_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->getGaugeBarChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getGaugeBarChartConfig

Get the configuration informations of an existing chart


/service/charts/gauge_bar/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_bar/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeBarChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            GaugeBarChartConfig result = apiInstance.getGaugeBarChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#getGaugeBarChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeBarChartControllerApi;

public class GaugeBarChartControllerApiExample {

    public static void main(String[] args) {
        GaugeBarChartControllerApi apiInstance = new GaugeBarChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            GaugeBarChartConfig result = apiInstance.getGaugeBarChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeBarChartControllerApi#getGaugeBarChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeBarChartControllerApi *apiInstance = [[GaugeBarChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getGaugeBarChartConfigWith:id
    project:project
              completionHandler: ^(GaugeBarChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeBarChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGaugeBarChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGaugeBarChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeBarChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                GaugeBarChartConfig result = apiInstance.getGaugeBarChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeBarChartControllerApi.getGaugeBarChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeBarChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGaugeBarChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeBarChartControllerApi->getGaugeBarChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeBarChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeBarChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGaugeBarChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeBarChartControllerApi->getGaugeBarChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeBarChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_gauge_bar_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeBarChartControllerApi->getGaugeBarChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


GaugeCircularChartController

checkConfigUsingGET3

Check the configuration informations of an existing chart


/service/charts/gauge_circular/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_circular/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET3(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#checkConfigUsingGET3");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET3(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#checkConfigUsingGET3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET3With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET3(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET3Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET3(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.checkConfigUsingGET3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET3($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->checkConfigUsingGET3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET3(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->checkConfigUsingGET3: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get3(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->checkConfigUsingGET3: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createGaugeCircularChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/gauge_circular

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_circular?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeCircularChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#createGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeCircularChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#createGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Create a new chart
[apiInstance createGaugeCircularChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGaugeCircularChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGaugeCircularChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createGaugeCircularChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.createGaugeCircularChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createGaugeCircularChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->createGaugeCircularChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createGaugeCircularChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->createGaugeCircularChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_gauge_circular_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->createGaugeCircularChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createGaugeCircularChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/gauge_circular/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_circular/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeCircularChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#createGaugeCircularChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeCircularChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#createGaugeCircularChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createGaugeCircularChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGaugeCircularChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGaugeCircularChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createGaugeCircularChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.createGaugeCircularChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createGaugeCircularChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->createGaugeCircularChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createGaugeCircularChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->createGaugeCircularChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_gauge_circular_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->createGaugeCircularChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteGaugeCircularChart

Delete an existing chart


/service/charts/gauge_circular/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/gauge_circular/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteGaugeCircularChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#deleteGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteGaugeCircularChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#deleteGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteGaugeCircularChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteGaugeCircularChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteGaugeCircularChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteGaugeCircularChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.deleteGaugeCircularChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteGaugeCircularChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->deleteGaugeCircularChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteGaugeCircularChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->deleteGaugeCircularChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_gauge_circular_chart(id, project=project)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->deleteGaugeCircularChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateGaugeCircularChart

Duplicate an existing chart


/service/charts/gauge_circular/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_circular/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateGaugeCircularChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#duplicateGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateGaugeCircularChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#duplicateGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateGaugeCircularChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateGaugeCircularChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateGaugeCircularChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateGaugeCircularChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.duplicateGaugeCircularChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateGaugeCircularChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->duplicateGaugeCircularChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateGaugeCircularChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->duplicateGaugeCircularChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_gauge_circular_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->duplicateGaugeCircularChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editGaugeCircularChart

Edit chart

Edit an existing chart


/service/charts/gauge_circular/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_circular/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeCircularChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#editGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeCircularChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#editGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Edit chart
[apiInstance editGaugeCircularChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGaugeCircularChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGaugeCircularChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editGaugeCircularChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.editGaugeCircularChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editGaugeCircularChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->editGaugeCircularChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editGaugeCircularChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->editGaugeCircularChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_gauge_circular_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->editGaugeCircularChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editGaugeCircularChartConfig

Update the configuration informations of an existing chart


/service/charts/gauge_circular/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_circular/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        UpdateGaugeCircularChartConfigEntry body = ; // UpdateGaugeCircularChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeCircularChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#editGaugeCircularChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        UpdateGaugeCircularChartConfigEntry body = ; // UpdateGaugeCircularChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeCircularChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#editGaugeCircularChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateGaugeCircularChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editGaugeCircularChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var body = ; // {{UpdateGaugeCircularChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGaugeCircularChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGaugeCircularChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var body = new UpdateGaugeCircularChartConfigEntry(); // UpdateGaugeCircularChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editGaugeCircularChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.editGaugeCircularChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$body = ; // UpdateGaugeCircularChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editGaugeCircularChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->editGaugeCircularChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateGaugeCircularChartConfigEntry->new(); # UpdateGaugeCircularChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editGaugeCircularChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->editGaugeCircularChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
body =  # UpdateGaugeCircularChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_gauge_circular_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->editGaugeCircularChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getGaugeCircularChart

Get a chart by Id


/service/charts/gauge_circular/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_circular/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getGaugeCircularChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#getGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getGaugeCircularChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#getGaugeCircularChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getGaugeCircularChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGaugeCircularChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGaugeCircularChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getGaugeCircularChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.getGaugeCircularChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGaugeCircularChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->getGaugeCircularChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGaugeCircularChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->getGaugeCircularChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_gauge_circular_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->getGaugeCircularChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getGaugeCircularChartConfig

Get the configuration informations of an existing chart


/service/charts/gauge_circular/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_circular/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeCircularChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            GaugeCircularChartConfig result = apiInstance.getGaugeCircularChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#getGaugeCircularChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeCircularChartControllerApi;

public class GaugeCircularChartControllerApiExample {

    public static void main(String[] args) {
        GaugeCircularChartControllerApi apiInstance = new GaugeCircularChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            GaugeCircularChartConfig result = apiInstance.getGaugeCircularChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeCircularChartControllerApi#getGaugeCircularChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeCircularChartControllerApi *apiInstance = [[GaugeCircularChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getGaugeCircularChartConfigWith:id
    project:project
              completionHandler: ^(GaugeCircularChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeCircularChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGaugeCircularChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGaugeCircularChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeCircularChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                GaugeCircularChartConfig result = apiInstance.getGaugeCircularChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeCircularChartControllerApi.getGaugeCircularChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeCircularChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGaugeCircularChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeCircularChartControllerApi->getGaugeCircularChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeCircularChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeCircularChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGaugeCircularChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeCircularChartControllerApi->getGaugeCircularChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeCircularChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_gauge_circular_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeCircularChartControllerApi->getGaugeCircularChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


GaugeLinearChartController

checkConfigUsingGET4

Check the configuration informations of an existing chart


/service/charts/gauge_linear/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_linear/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET4(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#checkConfigUsingGET4");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET4(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#checkConfigUsingGET4");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET4With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET4(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET4Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET4(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.checkConfigUsingGET4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET4($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->checkConfigUsingGET4: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET4(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->checkConfigUsingGET4: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get4(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->checkConfigUsingGET4: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createGaugeLinearChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/gauge_linear

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_linear?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeLinearChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#createGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeLinearChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#createGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Create a new chart
[apiInstance createGaugeLinearChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGaugeLinearChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGaugeLinearChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createGaugeLinearChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.createGaugeLinearChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createGaugeLinearChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->createGaugeLinearChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createGaugeLinearChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->createGaugeLinearChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_gauge_linear_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->createGaugeLinearChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createGaugeLinearChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/gauge_linear/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_linear/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeLinearChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#createGaugeLinearChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createGaugeLinearChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#createGaugeLinearChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createGaugeLinearChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGaugeLinearChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGaugeLinearChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createGaugeLinearChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.createGaugeLinearChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createGaugeLinearChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->createGaugeLinearChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createGaugeLinearChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->createGaugeLinearChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_gauge_linear_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->createGaugeLinearChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteGaugeLinearChart

Delete an existing chart


/service/charts/gauge_linear/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/gauge_linear/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteGaugeLinearChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#deleteGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteGaugeLinearChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#deleteGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteGaugeLinearChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteGaugeLinearChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteGaugeLinearChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteGaugeLinearChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.deleteGaugeLinearChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteGaugeLinearChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->deleteGaugeLinearChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteGaugeLinearChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->deleteGaugeLinearChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_gauge_linear_chart(id, project=project)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->deleteGaugeLinearChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateGaugeLinearChart

Duplicate an existing chart


/service/charts/gauge_linear/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_linear/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateGaugeLinearChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#duplicateGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateGaugeLinearChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#duplicateGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateGaugeLinearChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateGaugeLinearChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateGaugeLinearChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateGaugeLinearChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.duplicateGaugeLinearChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateGaugeLinearChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->duplicateGaugeLinearChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateGaugeLinearChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->duplicateGaugeLinearChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_gauge_linear_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->duplicateGaugeLinearChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editGaugeLinearChart

Edit chart

Edit an existing chart


/service/charts/gauge_linear/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_linear/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeLinearChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#editGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeLinearChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#editGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Edit chart
[apiInstance editGaugeLinearChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGaugeLinearChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGaugeLinearChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editGaugeLinearChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.editGaugeLinearChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editGaugeLinearChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->editGaugeLinearChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editGaugeLinearChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->editGaugeLinearChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_gauge_linear_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->editGaugeLinearChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editGaugeLinearChartConfig

Update the configuration informations of an existing chart


/service/charts/gauge_linear/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/gauge_linear/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        UpdateGaugeLinearChartConfigEntry body = ; // UpdateGaugeLinearChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeLinearChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#editGaugeLinearChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        UpdateGaugeLinearChartConfigEntry body = ; // UpdateGaugeLinearChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editGaugeLinearChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#editGaugeLinearChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateGaugeLinearChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editGaugeLinearChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var body = ; // {{UpdateGaugeLinearChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGaugeLinearChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGaugeLinearChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var body = new UpdateGaugeLinearChartConfigEntry(); // UpdateGaugeLinearChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editGaugeLinearChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.editGaugeLinearChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$body = ; // UpdateGaugeLinearChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editGaugeLinearChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->editGaugeLinearChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateGaugeLinearChartConfigEntry->new(); # UpdateGaugeLinearChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editGaugeLinearChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->editGaugeLinearChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
body =  # UpdateGaugeLinearChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_gauge_linear_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->editGaugeLinearChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getGaugeLinearChart

Get a chart by Id


/service/charts/gauge_linear/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_linear/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getGaugeLinearChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#getGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getGaugeLinearChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#getGaugeLinearChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getGaugeLinearChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGaugeLinearChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGaugeLinearChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getGaugeLinearChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.getGaugeLinearChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGaugeLinearChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->getGaugeLinearChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGaugeLinearChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->getGaugeLinearChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_gauge_linear_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->getGaugeLinearChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getGaugeLinearChartConfig

Get the configuration informations of an existing chart


/service/charts/gauge_linear/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/gauge_linear/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GaugeLinearChartControllerApi;

import java.io.File;
import java.util.*;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            GaugeLinearChartConfig result = apiInstance.getGaugeLinearChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#getGaugeLinearChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GaugeLinearChartControllerApi;

public class GaugeLinearChartControllerApiExample {

    public static void main(String[] args) {
        GaugeLinearChartControllerApi apiInstance = new GaugeLinearChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            GaugeLinearChartConfig result = apiInstance.getGaugeLinearChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GaugeLinearChartControllerApi#getGaugeLinearChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

GaugeLinearChartControllerApi *apiInstance = [[GaugeLinearChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getGaugeLinearChartConfigWith:id
    project:project
              completionHandler: ^(GaugeLinearChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GaugeLinearChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGaugeLinearChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGaugeLinearChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GaugeLinearChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                GaugeLinearChartConfig result = apiInstance.getGaugeLinearChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GaugeLinearChartControllerApi.getGaugeLinearChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGaugeLinearChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getGaugeLinearChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GaugeLinearChartControllerApi->getGaugeLinearChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GaugeLinearChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GaugeLinearChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getGaugeLinearChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GaugeLinearChartControllerApi->getGaugeLinearChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GaugeLinearChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_gauge_linear_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GaugeLinearChartControllerApi->getGaugeLinearChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


GroupController

addMember

Add a user to group members


/service/groups/{id}/members

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/groups/{id}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String body = ; // String | User Id
        String id = id_example; // String | id
        try {
            apiInstance.addMember(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#addMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String body = ; // String | User Id
        String id = id_example; // String | id
        try {
            apiInstance.addMember(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#addMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *body = ; // User Id
String *id = id_example; // id

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Add a user to group members
[apiInstance addMemberWith:body
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var body = ; // {{String}} User Id
var id = id_example; // {{String}} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addMember(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addMemberExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var body = new String(); // String | User Id
            var id = id_example;  // String | id

            try
            {
                // Add a user to group members
                apiInstance.addMember(body, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.addMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$body = ; // String | User Id
$id = id_example; // String | id

try {
    $api_instance->addMember($body, $id);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->addMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | User Id
my $id = id_example; # String | id

eval { 
    $api_instance->addMember(body => $body, id => $id);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->addMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
body =  # String | User Id
id = id_example # String | id

try: 
    # Add a user to group members
    api_instance.add_member(body, id)
except ApiException as e:
    print("Exception when calling GroupControllerApi->addMember: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
id
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


createGroup

Create a new Group

Create a new Group and returns the new generated Id


/service/groups

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        DcGroupConfig body = ; // DcGroupConfig | New userGroup data
        try {
            Long result = apiInstance.createGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#createGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        DcGroupConfig body = ; // DcGroupConfig | New userGroup data
        try {
            Long result = apiInstance.createGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#createGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DcGroupConfig *body = ; // New userGroup data

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Create a new Group
[apiInstance createGroupWith:body
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var body = ; // {{DcGroupConfig}} New userGroup data

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGroup(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var body = new DcGroupConfig(); // DcGroupConfig | New userGroup data

            try
            {
                // Create a new Group
                Long result = apiInstance.createGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.createGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$body = ; // DcGroupConfig | New userGroup data

try {
    $result = $api_instance->createGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $body = WWW::SwaggerClient::Object::DcGroupConfig->new(); # DcGroupConfig | New userGroup data

eval { 
    my $result = $api_instance->createGroup(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->createGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
body =  # DcGroupConfig | New userGroup data

try: 
    # Create a new Group
    api_response = api_instance.create_group(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->createGroup: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteGroup

Delete an existing Group


/service/groups/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | The Id of the Group to be deleted
        try {
            apiInstance.deleteGroup(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#deleteGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | The Id of the Group to be deleted
        try {
            apiInstance.deleteGroup(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#deleteGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // The Id of the Group to be deleted

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Delete an existing Group
[apiInstance deleteGroupWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var id = id_example; // {{String}} The Id of the Group to be deleted

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteGroup(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var id = id_example;  // String | The Id of the Group to be deleted

            try
            {
                // Delete an existing Group
                apiInstance.deleteGroup(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.deleteGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$id = id_example; // String | The Id of the Group to be deleted

try {
    $api_instance->deleteGroup($id);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $id = id_example; # String | The Id of the Group to be deleted

eval { 
    $api_instance->deleteGroup(id => $id);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->deleteGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
id = id_example # String | The Id of the Group to be deleted

try: 
    # Delete an existing Group
    api_instance.delete_group(id)
except ApiException as e:
    print("Exception when calling GroupControllerApi->deleteGroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The Id of the Group to be deleted
Required

Responses

Status: 200 - OK


deleteManyGroups

Delete a list of Groups


/service/groups

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/groups?groupsId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        array[String] groupsId = ; // array[String] | Requested Group Ids
        try {
            apiInstance.deleteManyGroups(groupsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#deleteManyGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        array[String] groupsId = ; // array[String] | Requested Group Ids
        try {
            apiInstance.deleteManyGroups(groupsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#deleteManyGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *groupsId = ; // Requested Group Ids

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Delete a list of Groups
[apiInstance deleteManyGroupsWith:groupsId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var groupsId = ; // {{array[String]}} Requested Group Ids

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteManyGroups(groupsId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteManyGroupsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var groupsId = new array[String](); // array[String] | Requested Group Ids

            try
            {
                // Delete a list of Groups
                apiInstance.deleteManyGroups(groupsId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.deleteManyGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$groupsId = ; // array[String] | Requested Group Ids

try {
    $api_instance->deleteManyGroups($groupsId);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->deleteManyGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $groupsId = []; # array[String] | Requested Group Ids

eval { 
    $api_instance->deleteManyGroups(groupsId => $groupsId);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->deleteManyGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
groupsId =  # array[String] | Requested Group Ids

try: 
    # Delete a list of Groups
    api_instance.delete_many_groups(groupsId)
except ApiException as e:
    print("Exception when calling GroupControllerApi->deleteManyGroups: %s\n" % e)

Parameters

Query parameters
Name Description
groupsId*
array[String]
Requested Group Ids
Required

Responses

Status: 200 - OK


editGroup

Edit Group

Edit an existing Group


/service/groups/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        DcGroupConfig body = ; // DcGroupConfig | Update group config data
        String id = id_example; // String | Id of group to update data
        try {
            apiInstance.editGroup(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#editGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        DcGroupConfig body = ; // DcGroupConfig | Update group config data
        String id = id_example; // String | Id of group to update data
        try {
            apiInstance.editGroup(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#editGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DcGroupConfig *body = ; // Update group config data
String *id = id_example; // Id of group to update data

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Edit Group
[apiInstance editGroupWith:body
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var body = ; // {{DcGroupConfig}} Update group config data
var id = id_example; // {{String}} Id of group to update data

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editGroup(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var body = new DcGroupConfig(); // DcGroupConfig | Update group config data
            var id = id_example;  // String | Id of group to update data

            try
            {
                // Edit Group
                apiInstance.editGroup(body, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.editGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$body = ; // DcGroupConfig | Update group config data
$id = id_example; // String | Id of group to update data

try {
    $api_instance->editGroup($body, $id);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->editGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $body = WWW::SwaggerClient::Object::DcGroupConfig->new(); # DcGroupConfig | Update group config data
my $id = id_example; # String | Id of group to update data

eval { 
    $api_instance->editGroup(body => $body, id => $id);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->editGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
body =  # DcGroupConfig | Update group config data
id = id_example # String | Id of group to update data

try: 
    # Edit Group
    api_instance.edit_group(body, id)
except ApiException as e:
    print("Exception when calling GroupControllerApi->editGroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id of group to update data
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


getAllGroups

Get a list of the available Groups


/service/groups

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        try {
            array[DcGroup] result = apiInstance.getAllGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getAllGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        try {
            array[DcGroup] result = apiInstance.getAllGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getAllGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Get a list of the available Groups
[apiInstance getAllGroupsWithCompletionHandler: 
              ^(array[DcGroup] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllGroups(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllGroupsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();

            try
            {
                // Get a list of the available Groups
                array[DcGroup] result = apiInstance.getAllGroups();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.getAllGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();

try {
    $result = $api_instance->getAllGroups();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getAllGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();

eval { 
    my $result = $api_instance->getAllGroups();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->getAllGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()

try: 
    # Get a list of the available Groups
    api_response = api_instance.get_all_groups()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->getAllGroups: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getAvailableUsers

Get a list of available users


/service/groups/available_users

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/groups/available_users?groupId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String groupId = groupId_example; // String | groupId
        try {
            array[GroupMember] result = apiInstance.getAvailableUsers(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getAvailableUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String groupId = groupId_example; // String | groupId
        try {
            array[GroupMember] result = apiInstance.getAvailableUsers(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getAvailableUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *groupId = groupId_example; // groupId (optional)

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Get a list of available users
[apiInstance getAvailableUsersWith:groupId
              completionHandler: ^(array[GroupMember] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var opts = { 
  'groupId': groupId_example // {{String}} groupId
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailableUsers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAvailableUsersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var groupId = groupId_example;  // String | groupId (optional) 

            try
            {
                // Get a list of available users
                array[GroupMember] result = apiInstance.getAvailableUsers(groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.getAvailableUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$groupId = groupId_example; // String | groupId

try {
    $result = $api_instance->getAvailableUsers($groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getAvailableUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $groupId = groupId_example; # String | groupId

eval { 
    my $result = $api_instance->getAvailableUsers(groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->getAvailableUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
groupId = groupId_example # String | groupId (optional)

try: 
    # Get a list of available users
    api_response = api_instance.get_available_users(groupId=groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->getAvailableUsers: %s\n" % e)

Parameters

Query parameters
Name Description
groupId
String
groupId

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCurrentUserGroups

Get a list of groups of the current user


/service/users/groups

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/users/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        try {
            array[DcGroup] result = apiInstance.getCurrentUserGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getCurrentUserGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        try {
            array[DcGroup] result = apiInstance.getCurrentUserGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getCurrentUserGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Get a list of groups of the current user
[apiInstance getCurrentUserGroupsWithCompletionHandler: 
              ^(array[DcGroup] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrentUserGroups(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCurrentUserGroupsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();

            try
            {
                // Get a list of groups of the current user
                array[DcGroup] result = apiInstance.getCurrentUserGroups();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.getCurrentUserGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();

try {
    $result = $api_instance->getCurrentUserGroups();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getCurrentUserGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();

eval { 
    my $result = $api_instance->getCurrentUserGroups();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->getCurrentUserGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()

try: 
    # Get a list of groups of the current user
    api_response = api_instance.get_current_user_groups()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->getCurrentUserGroups: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getGroup

Get a Group by Id


/service/groups/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | Requested Group Id
        try {
            DcGroup result = apiInstance.getGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | Requested Group Id
        try {
            DcGroup result = apiInstance.getGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Requested Group Id

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Get a Group by Id
[apiInstance getGroupWith:id
              completionHandler: ^(DcGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var id = id_example; // {{String}} Requested Group Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroup(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var id = id_example;  // String | Requested Group Id

            try
            {
                // Get a Group by Id
                DcGroup result = apiInstance.getGroup(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.getGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$id = id_example; // String | Requested Group Id

try {
    $result = $api_instance->getGroup($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $id = id_example; # String | Requested Group Id

eval { 
    my $result = $api_instance->getGroup(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->getGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
id = id_example # String | Requested Group Id

try: 
    # Get a Group by Id
    api_response = api_instance.get_group(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->getGroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Requested Group Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getGroupMembers

Get a list of the Group members


/service/groups/{id}/members

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/groups/{id}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | Requested Group Id
        try {
            array[GroupMember] result = apiInstance.getGroupMembers(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getGroupMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | Requested Group Id
        try {
            array[GroupMember] result = apiInstance.getGroupMembers(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getGroupMembers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Requested Group Id

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Get a list of the Group members
[apiInstance getGroupMembersWith:id
              completionHandler: ^(array[GroupMember] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var id = id_example; // {{String}} Requested Group Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroupMembers(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGroupMembersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var id = id_example;  // String | Requested Group Id

            try
            {
                // Get a list of the Group members
                array[GroupMember] result = apiInstance.getGroupMembers(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.getGroupMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$id = id_example; // String | Requested Group Id

try {
    $result = $api_instance->getGroupMembers($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getGroupMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $id = id_example; # String | Requested Group Id

eval { 
    my $result = $api_instance->getGroupMembers(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->getGroupMembers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
id = id_example # String | Requested Group Id

try: 
    # Get a list of the Group members
    api_response = api_instance.get_group_members(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->getGroupMembers: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Requested Group Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getUserGroups

Get a list of groups of a user


/service/groups/by_user/{userId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/groups/by_user/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String userId = userId_example; // String | userId
        try {
            array[DcGroup] result = apiInstance.getUserGroups(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getUserGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String userId = userId_example; // String | userId
        try {
            array[DcGroup] result = apiInstance.getUserGroups(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#getUserGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *userId = userId_example; // userId

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Get a list of groups of a user
[apiInstance getUserGroupsWith:userId
              completionHandler: ^(array[DcGroup] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var userId = userId_example; // {{String}} userId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserGroups(userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserGroupsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var userId = userId_example;  // String | userId

            try
            {
                // Get a list of groups of a user
                array[DcGroup] result = apiInstance.getUserGroups(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.getUserGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$userId = userId_example; // String | userId

try {
    $result = $api_instance->getUserGroups($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getUserGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $userId = userId_example; # String | userId

eval { 
    my $result = $api_instance->getUserGroups(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->getUserGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
userId = userId_example # String | userId

try: 
    # Get a list of groups of a user
    api_response = api_instance.get_user_groups(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupControllerApi->getUserGroups: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
userId
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


removeMember

Remove a user from group members


/service/groups/{id}/members/{userId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/groups/{id}/members/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupControllerApi;

import java.io.File;
import java.util.*;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | id
        String userId = userId_example; // String | User Id
        try {
            apiInstance.removeMember(id, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#removeMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupControllerApi;

public class GroupControllerApiExample {

    public static void main(String[] args) {
        GroupControllerApi apiInstance = new GroupControllerApi();
        String id = id_example; // String | id
        String userId = userId_example; // String | User Id
        try {
            apiInstance.removeMember(id, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupControllerApi#removeMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // id
String *userId = userId_example; // User Id

GroupControllerApi *apiInstance = [[GroupControllerApi alloc] init];

// Remove a user from group members
[apiInstance removeMemberWith:id
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.GroupControllerApi()
var id = id_example; // {{String}} id
var userId = userId_example; // {{String}} User Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeMember(id, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeMemberExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GroupControllerApi();
            var id = id_example;  // String | id
            var userId = userId_example;  // String | User Id

            try
            {
                // Remove a user from group members
                apiInstance.removeMember(id, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupControllerApi.removeMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGroupControllerApi();
$id = id_example; // String | id
$userId = userId_example; // String | User Id

try {
    $api_instance->removeMember($id, $userId);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->removeMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GroupControllerApi->new();
my $id = id_example; # String | id
my $userId = userId_example; # String | User Id

eval { 
    $api_instance->removeMember(id => $id, userId => $userId);
};
if ($@) {
    warn "Exception when calling GroupControllerApi->removeMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GroupControllerApi()
id = id_example # String | id
userId = userId_example # String | User Id

try: 
    # Remove a user from group members
    api_instance.remove_member(id, userId)
except ApiException as e:
    print("Exception when calling GroupControllerApi->removeMember: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
id
Required
userId*
String
User Id
Required

Responses

Status: 200 - OK


HdOptionsController

getAllHdCenteringOptions

Get all centering options


/service/options/hd/centering

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/options/hd/centering?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdOptionsControllerApi;

import java.io.File;
import java.util.*;

public class HdOptionsControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdOptionsControllerApi apiInstance = new HdOptionsControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            CenteringOptions result = apiInstance.getAllHdCenteringOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdOptionsControllerApi#getAllHdCenteringOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdOptionsControllerApi;

public class HdOptionsControllerApiExample {

    public static void main(String[] args) {
        HdOptionsControllerApi apiInstance = new HdOptionsControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            CenteringOptions result = apiInstance.getAllHdCenteringOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdOptionsControllerApi#getAllHdCenteringOptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

HdOptionsControllerApi *apiInstance = [[HdOptionsControllerApi alloc] init];

// Get all centering options
[apiInstance getAllHdCenteringOptionsWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(CenteringOptions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdOptionsControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllHdCenteringOptions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllHdCenteringOptionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdOptionsControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get all centering options
                CenteringOptions result = apiInstance.getAllHdCenteringOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdOptionsControllerApi.getAllHdCenteringOptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdOptionsControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getAllHdCenteringOptions($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdOptionsControllerApi->getAllHdCenteringOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdOptionsControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdOptionsControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getAllHdCenteringOptions(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdOptionsControllerApi->getAllHdCenteringOptions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdOptionsControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get all centering options
    api_response = api_instance.get_all_hd_centering_options(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdOptionsControllerApi->getAllHdCenteringOptions: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getAllHdChartOptions

Get all chart config options


/service/options/hd/chart

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/options/hd/chart?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdOptionsControllerApi;

import java.io.File;
import java.util.*;

public class HdOptionsControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdOptionsControllerApi apiInstance = new HdOptionsControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            ChartOptions result = apiInstance.getAllHdChartOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdOptionsControllerApi#getAllHdChartOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdOptionsControllerApi;

public class HdOptionsControllerApiExample {

    public static void main(String[] args) {
        HdOptionsControllerApi apiInstance = new HdOptionsControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            ChartOptions result = apiInstance.getAllHdChartOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdOptionsControllerApi#getAllHdChartOptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

HdOptionsControllerApi *apiInstance = [[HdOptionsControllerApi alloc] init];

// Get all chart config options
[apiInstance getAllHdChartOptionsWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(ChartOptions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdOptionsControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllHdChartOptions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllHdChartOptionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdOptionsControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get all chart config options
                ChartOptions result = apiInstance.getAllHdChartOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdOptionsControllerApi.getAllHdChartOptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdOptionsControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getAllHdChartOptions($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdOptionsControllerApi->getAllHdChartOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdOptionsControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdOptionsControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getAllHdChartOptions(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdOptionsControllerApi->getAllHdChartOptions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdOptionsControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get all chart config options
    api_response = api_instance.get_all_hd_chart_options(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdOptionsControllerApi->getAllHdChartOptions: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getAllHdGridOptions

Get all grid config options


/service/options/hd/grid

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/options/hd/grid?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdOptionsControllerApi;

import java.io.File;
import java.util.*;

public class HdOptionsControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdOptionsControllerApi apiInstance = new HdOptionsControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            GridOptions result = apiInstance.getAllHdGridOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdOptionsControllerApi#getAllHdGridOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdOptionsControllerApi;

public class HdOptionsControllerApiExample {

    public static void main(String[] args) {
        HdOptionsControllerApi apiInstance = new HdOptionsControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            GridOptions result = apiInstance.getAllHdGridOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdOptionsControllerApi#getAllHdGridOptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

HdOptionsControllerApi *apiInstance = [[HdOptionsControllerApi alloc] init];

// Get all grid config options
[apiInstance getAllHdGridOptionsWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(GridOptions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdOptionsControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllHdGridOptions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllHdGridOptionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdOptionsControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get all grid config options
                GridOptions result = apiInstance.getAllHdGridOptions(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdOptionsControllerApi.getAllHdGridOptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdOptionsControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getAllHdGridOptions($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdOptionsControllerApi->getAllHdGridOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdOptionsControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdOptionsControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getAllHdGridOptions(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdOptionsControllerApi->getAllHdGridOptions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdOptionsControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get all grid config options
    api_response = api_instance.get_all_hd_grid_options(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdOptionsControllerApi->getAllHdGridOptions: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


HdSourceController

activateHdSource

Activate/deactivate an existing source


/service/hd_source/{hdType}/{hdId}/{id}/activate/{active}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hd_source/{hdType}/{hdId}/{id}/activate/{active}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Boolean active = true; // Boolean | Activate
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Id of source to activate/deactivate
        Long project = 789; // Long | Project id
        try {
            apiInstance.activateHdSource(active, hdId, hdType, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#activateHdSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Boolean active = true; // Boolean | Activate
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Id of source to activate/deactivate
        Long project = 789; // Long | Project id
        try {
            apiInstance.activateHdSource(active, hdId, hdType, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#activateHdSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // Activate
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *id = 789; // Id of source to activate/deactivate
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Activate/deactivate an existing source
[apiInstance activateHdSourceWith:active
    hdId:hdId
    hdType:hdType
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var active = true; // {{Boolean}} Activate
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var id = 789; // {{Long}} Id of source to activate/deactivate
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activateHdSource(active, hdId, hdType, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class activateHdSourceExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var active = true;  // Boolean | Activate
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var id = 789;  // Long | Id of source to activate/deactivate
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Activate/deactivate an existing source
                apiInstance.activateHdSource(active, hdId, hdType, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.activateHdSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$active = true; // Boolean | Activate
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$id = 789; // Long | Id of source to activate/deactivate
$project = 789; // Long | Project id

try {
    $api_instance->activateHdSource($active, $hdId, $hdType, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->activateHdSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $active = true; # Boolean | Activate
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $id = 789; # Long | Id of source to activate/deactivate
my $project = 789; # Long | Project id

eval { 
    $api_instance->activateHdSource(active => $active, hdId => $hdId, hdType => $hdType, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->activateHdSource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
active = true # Boolean | Activate
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
id = 789 # Long | Id of source to activate/deactivate
project = 789 # Long | Project id (optional)

try: 
    # Activate/deactivate an existing source
    api_instance.activate_hd_source(active, hdId, hdType, id, project=project)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->activateHdSource: %s\n" % e)

Parameters

Path parameters
Name Description
active*
Boolean
Activate
Required
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
id*
Long (int64)
Id of source to activate/deactivate
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


autocomplete

Autocomplete


/service/hdsource/autocomplete

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/hdsource/autocomplete?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        AutocompleteEntry body = ; // AutocompleteEntry | autocomplete params
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.autocomplete(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#autocomplete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        AutocompleteEntry body = ; // AutocompleteEntry | autocomplete params
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.autocomplete(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#autocomplete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AutocompleteEntry *body = ; // autocomplete params
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Autocomplete
[apiInstance autocompleteWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var body = ; // {{AutocompleteEntry}} autocomplete params
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.autocomplete(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class autocompleteExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var body = new AutocompleteEntry(); // AutocompleteEntry | autocomplete params
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Autocomplete
                array['String'] result = apiInstance.autocomplete(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.autocomplete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$body = ; // AutocompleteEntry | autocomplete params
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->autocomplete($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->autocomplete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $body = WWW::SwaggerClient::Object::AutocompleteEntry->new(); # AutocompleteEntry | autocomplete params
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->autocomplete(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->autocomplete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
body =  # AutocompleteEntry | autocomplete params
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Autocomplete
    api_response = api_instance.autocomplete(body, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->autocomplete: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


autocompletePublicationUsingPOST

autocompletePublication


/service/dashboard_publication/autocomplete

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboard_publication/autocomplete?link="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        AutocompletePubEntry body = ; // AutocompletePubEntry | autocomplete
        String link = link_example; // String | link
        try {
            array['String'] result = apiInstance.autocompletePublicationUsingPOST(body, link);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#autocompletePublicationUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        AutocompletePubEntry body = ; // AutocompletePubEntry | autocomplete
        String link = link_example; // String | link
        try {
            array['String'] result = apiInstance.autocompletePublicationUsingPOST(body, link);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#autocompletePublicationUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AutocompletePubEntry *body = ; // autocomplete
String *link = link_example; // link

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// autocompletePublication
[apiInstance autocompletePublicationUsingPOSTWith:body
    link:link
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var body = ; // {{AutocompletePubEntry}} autocomplete
var link = link_example; // {{String}} link

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.autocompletePublicationUsingPOST(bodylink, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class autocompletePublicationUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var body = new AutocompletePubEntry(); // AutocompletePubEntry | autocomplete
            var link = link_example;  // String | link

            try
            {
                // autocompletePublication
                array['String'] result = apiInstance.autocompletePublicationUsingPOST(body, link);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.autocompletePublicationUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$body = ; // AutocompletePubEntry | autocomplete
$link = link_example; // String | link

try {
    $result = $api_instance->autocompletePublicationUsingPOST($body, $link);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->autocompletePublicationUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $body = WWW::SwaggerClient::Object::AutocompletePubEntry->new(); # AutocompletePubEntry | autocomplete
my $link = link_example; # String | link

eval { 
    my $result = $api_instance->autocompletePublicationUsingPOST(body => $body, link => $link);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->autocompletePublicationUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
body =  # AutocompletePubEntry | autocomplete
link = link_example # String | link

try: 
    # autocompletePublication
    api_response = api_instance.autocomplete_publication_using_post(body, link)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->autocompletePublicationUsingPOST: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
link*

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createHdSources

Create new sources for a hd element


/service/hd_source/{hdType}/{hdId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/hd_source/{hdType}/{hdId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        array[CreateHdSourceEntry] body = ; // array[CreateHdSourceEntry] | Sources
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long project = 789; // Long | Project id
        try {
            apiInstance.createHdSources(body, hdId, hdType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#createHdSources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        array[CreateHdSourceEntry] body = ; // array[CreateHdSourceEntry] | Sources
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long project = 789; // Long | Project id
        try {
            apiInstance.createHdSources(body, hdId, hdType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#createHdSources");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[CreateHdSourceEntry] *body = ; // Sources
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Create new sources for a hd element
[apiInstance createHdSourcesWith:body
    hdId:hdId
    hdType:hdType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var body = ; // {{array[CreateHdSourceEntry]}} Sources
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createHdSources(bodyhdIdhdType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createHdSourcesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var body = new array[CreateHdSourceEntry](); // array[CreateHdSourceEntry] | Sources
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create new sources for a hd element
                apiInstance.createHdSources(body, hdId, hdType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.createHdSources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$body = ; // array[CreateHdSourceEntry] | Sources
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$project = 789; // Long | Project id

try {
    $api_instance->createHdSources($body, $hdId, $hdType, $project);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->createHdSources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[CreateHdSourceEntry]->new()]; # array[CreateHdSourceEntry] | Sources
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $project = 789; # Long | Project id

eval { 
    $api_instance->createHdSources(body => $body, hdId => $hdId, hdType => $hdType, project => $project);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->createHdSources: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
body =  # array[CreateHdSourceEntry] | Sources
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
project = 789 # Long | Project id (optional)

try: 
    # Create new sources for a hd element
    api_instance.create_hd_sources(body, hdId, hdType, project=project)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->createHdSources: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteHdSource

Delete an existing source


/service/hd_source/{hdType}/{hdId}/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/hd_source/{hdType}/{hdId}/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | The Id of hd element
        String hdType = hdType_example; // String | The type of hd element
        Long id = 789; // Long | The Id of the source to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteHdSource(hdId, hdType, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#deleteHdSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | The Id of hd element
        String hdType = hdType_example; // String | The type of hd element
        Long id = 789; // Long | The Id of the source to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteHdSource(hdId, hdType, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#deleteHdSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *hdId = 789; // The Id of hd element
String *hdType = hdType_example; // The type of hd element
Long *id = 789; // The Id of the source to be deleted
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Delete an existing source
[apiInstance deleteHdSourceWith:hdId
    hdType:hdType
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var hdId = 789; // {{Long}} The Id of hd element
var hdType = hdType_example; // {{String}} The type of hd element
var id = 789; // {{Long}} The Id of the source to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteHdSource(hdId, hdType, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteHdSourceExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var hdId = 789;  // Long | The Id of hd element
            var hdType = hdType_example;  // String | The type of hd element
            var id = 789;  // Long | The Id of the source to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing source
                apiInstance.deleteHdSource(hdId, hdType, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.deleteHdSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$hdId = 789; // Long | The Id of hd element
$hdType = hdType_example; // String | The type of hd element
$id = 789; // Long | The Id of the source to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteHdSource($hdId, $hdType, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->deleteHdSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $hdId = 789; # Long | The Id of hd element
my $hdType = hdType_example; # String | The type of hd element
my $id = 789; # Long | The Id of the source to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteHdSource(hdId => $hdId, hdType => $hdType, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->deleteHdSource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
hdId = 789 # Long | The Id of hd element
hdType = hdType_example # String | The type of hd element
id = 789 # Long | The Id of the source to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing source
    api_instance.delete_hd_source(hdId, hdType, id, project=project)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->deleteHdSource: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
The Id of hd element
Required
hdType*
String
The type of hd element
Required
id*
Long (int64)
The Id of the source to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editHdSource

Edit source

Update an existing source


/service/hd_source/{hdType}/{hdId}/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/hd_source/{hdType}/{hdId}/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        UpdateHdSourceEntry body = ; // UpdateHdSourceEntry | Update source data
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Id of the source to update
        Long project = 789; // Long | Project id
        try {
            apiInstance.editHdSource(body, hdId, hdType, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#editHdSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        UpdateHdSourceEntry body = ; // UpdateHdSourceEntry | Update source data
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Id of the source to update
        Long project = 789; // Long | Project id
        try {
            apiInstance.editHdSource(body, hdId, hdType, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#editHdSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateHdSourceEntry *body = ; // Update source data
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *id = 789; // Id of the source to update
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Edit source
[apiInstance editHdSourceWith:body
    hdId:hdId
    hdType:hdType
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var body = ; // {{UpdateHdSourceEntry}} Update source data
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var id = 789; // {{Long}} Id of the source to update
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editHdSource(bodyhdIdhdTypeid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editHdSourceExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var body = new UpdateHdSourceEntry(); // UpdateHdSourceEntry | Update source data
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var id = 789;  // Long | Id of the source to update
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit source
                apiInstance.editHdSource(body, hdId, hdType, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.editHdSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$body = ; // UpdateHdSourceEntry | Update source data
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$id = 789; // Long | Id of the source to update
$project = 789; // Long | Project id

try {
    $api_instance->editHdSource($body, $hdId, $hdType, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->editHdSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateHdSourceEntry->new(); # UpdateHdSourceEntry | Update source data
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $id = 789; # Long | Id of the source to update
my $project = 789; # Long | Project id

eval { 
    $api_instance->editHdSource(body => $body, hdId => $hdId, hdType => $hdType, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->editHdSource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
body =  # UpdateHdSourceEntry | Update source data
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
id = 789 # Long | Id of the source to update
project = 789 # Long | Project id (optional)

try: 
    # Edit source
    api_instance.edit_hd_source(body, hdId, hdType, id, project=project)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->editHdSource: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
id*
Long (int64)
Id of the source to update
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


filterAndAggregate

Filter and Aggregate Source


/service/hdsource/filter_and_aggregate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/hdsource/filter_and_aggregate?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        FilterAndAggregateEntry body = ; // FilterAndAggregateEntry | params
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.filterAndAggregate(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#filterAndAggregate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        FilterAndAggregateEntry body = ; // FilterAndAggregateEntry | params
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.filterAndAggregate(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#filterAndAggregate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
FilterAndAggregateEntry *body = ; // params
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Filter and Aggregate Source
[apiInstance filterAndAggregateWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var body = ; // {{FilterAndAggregateEntry}} params
var opts = { 
  'ctx': 56 // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filterAndAggregate(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class filterAndAggregateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var body = new FilterAndAggregateEntry(); // FilterAndAggregateEntry | params
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Filter and Aggregate Source
                array['String'] result = apiInstance.filterAndAggregate(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.filterAndAggregate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$body = ; // FilterAndAggregateEntry | params
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->filterAndAggregate($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->filterAndAggregate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $body = WWW::SwaggerClient::Object::FilterAndAggregateEntry->new(); # FilterAndAggregateEntry | params
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->filterAndAggregate(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->filterAndAggregate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
body =  # FilterAndAggregateEntry | params
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Filter and Aggregate Source
    api_response = api_instance.filter_and_aggregate(body, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->filterAndAggregate: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


filterAndAggregatePublication

filter And Aggregate Dashboard Publication


/service/dashboard_publication/filter_and_aggregate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/dashboard_publication/filter_and_aggregate?link="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        FilterAndAggregateEntry body = ; // FilterAndAggregateEntry | filterAndAggregateEntry
        String link = link_example; // String | link
        try {
            array['String'] result = apiInstance.filterAndAggregatePublication(body, link);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#filterAndAggregatePublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        FilterAndAggregateEntry body = ; // FilterAndAggregateEntry | filterAndAggregateEntry
        String link = link_example; // String | link
        try {
            array['String'] result = apiInstance.filterAndAggregatePublication(body, link);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#filterAndAggregatePublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
FilterAndAggregateEntry *body = ; // filterAndAggregateEntry
String *link = link_example; // link

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// filter And Aggregate Dashboard Publication
[apiInstance filterAndAggregatePublicationWith:body
    link:link
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var body = ; // {{FilterAndAggregateEntry}} filterAndAggregateEntry
var link = link_example; // {{String}} link

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filterAndAggregatePublication(bodylink, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class filterAndAggregatePublicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var body = new FilterAndAggregateEntry(); // FilterAndAggregateEntry | filterAndAggregateEntry
            var link = link_example;  // String | link

            try
            {
                // filter And Aggregate Dashboard Publication
                array['String'] result = apiInstance.filterAndAggregatePublication(body, link);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.filterAndAggregatePublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$body = ; // FilterAndAggregateEntry | filterAndAggregateEntry
$link = link_example; // String | link

try {
    $result = $api_instance->filterAndAggregatePublication($body, $link);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->filterAndAggregatePublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $body = WWW::SwaggerClient::Object::FilterAndAggregateEntry->new(); # FilterAndAggregateEntry | filterAndAggregateEntry
my $link = link_example; # String | link

eval { 
    my $result = $api_instance->filterAndAggregatePublication(body => $body, link => $link);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->filterAndAggregatePublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
body =  # FilterAndAggregateEntry | filterAndAggregateEntry
link = link_example # String | link

try: 
    # filter And Aggregate Dashboard Publication
    api_response = api_instance.filter_and_aggregate_publication(body, link)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->filterAndAggregatePublication: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
link*

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHdSource

Get a source by id


/service/hd_source/{hdType}/{hdId}/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hd_source/{hdType}/{hdId}/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Requested source Id
        Long project = 789; // Long | Project id
        try {
            HdSourceGrammar result = apiInstance.getHdSource(hdId, hdType, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Requested source Id
        Long project = 789; // Long | Project id
        try {
            HdSourceGrammar result = apiInstance.getHdSource(hdId, hdType, id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *id = 789; // Requested source Id
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Get a source by id
[apiInstance getHdSourceWith:hdId
    hdType:hdType
    id:id
    project:project
              completionHandler: ^(HdSourceGrammar output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var id = 789; // {{Long}} Requested source Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHdSource(hdId, hdType, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHdSourceExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var id = 789;  // Long | Requested source Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a source by id
                HdSourceGrammar result = apiInstance.getHdSource(hdId, hdType, id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.getHdSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$id = 789; // Long | Requested source Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHdSource($hdId, $hdType, $id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->getHdSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $id = 789; # Long | Requested source Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHdSource(hdId => $hdId, hdType => $hdType, id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->getHdSource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
id = 789 # Long | Requested source Id
project = 789 # Long | Project id (optional)

try: 
    # Get a source by id
    api_response = api_instance.get_hd_source(hdId, hdType, id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->getHdSource: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
id*
Long (int64)
Requested source Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHdSourceColumnOrigin

Get the origin of a column

Return the list of operations generating the column (from source to depot)


/service/hd_source/{hdType}/{hdId}/{id}/columns/{uuid}/origin

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hd_source/{hdType}/{hdId}/{id}/columns/{uuid}/origin?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | id
        String uuid = uuid_example; // String | Column uuid
        Long project = 789; // Long | Project id
        try {
            ColumnOrigin result = apiInstance.getHdSourceColumnOrigin(hdId, hdType, id, uuid, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSourceColumnOrigin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | id
        String uuid = uuid_example; // String | Column uuid
        Long project = 789; // Long | Project id
        try {
            ColumnOrigin result = apiInstance.getHdSourceColumnOrigin(hdId, hdType, id, uuid, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSourceColumnOrigin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *id = 789; // id
String *uuid = uuid_example; // Column uuid
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Get the origin of a column
[apiInstance getHdSourceColumnOriginWith:hdId
    hdType:hdType
    id:id
    uuid:uuid
    project:project
              completionHandler: ^(ColumnOrigin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var id = 789; // {{Long}} id
var uuid = uuid_example; // {{String}} Column uuid
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHdSourceColumnOrigin(hdId, hdType, id, uuid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHdSourceColumnOriginExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var id = 789;  // Long | id
            var uuid = uuid_example;  // String | Column uuid
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the origin of a column
                ColumnOrigin result = apiInstance.getHdSourceColumnOrigin(hdId, hdType, id, uuid, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.getHdSourceColumnOrigin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$id = 789; // Long | id
$uuid = uuid_example; // String | Column uuid
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHdSourceColumnOrigin($hdId, $hdType, $id, $uuid, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->getHdSourceColumnOrigin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $id = 789; # Long | id
my $uuid = uuid_example; # String | Column uuid
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHdSourceColumnOrigin(hdId => $hdId, hdType => $hdType, id => $id, uuid => $uuid, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->getHdSourceColumnOrigin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
id = 789 # Long | id
uuid = uuid_example # String | Column uuid
project = 789 # Long | Project id (optional)

try: 
    # Get the origin of a column
    api_response = api_instance.get_hd_source_column_origin(hdId, hdType, id, uuid, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->getHdSourceColumnOrigin: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
id*
Long (int64)
id
Required
uuid*
String
Column uuid
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHdSourceColumns

Get a list of available columns of a source


/service/hd_source/{hdType}/{hdId}/{id}/columns

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hd_source/{hdType}/{hdId}/{id}/columns?ignoreOperations=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Requested source Id
        Boolean ignoreOperations = true; // Boolean | Hd element Id
        Long project = 789; // Long | Project id
        try {
            array[DBBuilderColumn] result = apiInstance.getHdSourceColumns(hdId, hdType, id, ignoreOperations, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSourceColumns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long id = 789; // Long | Requested source Id
        Boolean ignoreOperations = true; // Boolean | Hd element Id
        Long project = 789; // Long | Project id
        try {
            array[DBBuilderColumn] result = apiInstance.getHdSourceColumns(hdId, hdType, id, ignoreOperations, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSourceColumns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *id = 789; // Requested source Id
Boolean *ignoreOperations = true; // Hd element Id (optional)
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Get a list of available columns of a source
[apiInstance getHdSourceColumnsWith:hdId
    hdType:hdType
    id:id
    ignoreOperations:ignoreOperations
    project:project
              completionHandler: ^(array[DBBuilderColumn] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var id = 789; // {{Long}} Requested source Id
var opts = { 
  'ignoreOperations': true, // {{Boolean}} Hd element Id
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHdSourceColumns(hdId, hdType, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHdSourceColumnsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var id = 789;  // Long | Requested source Id
            var ignoreOperations = true;  // Boolean | Hd element Id (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of available columns of a source
                array[DBBuilderColumn] result = apiInstance.getHdSourceColumns(hdId, hdType, id, ignoreOperations, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.getHdSourceColumns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$id = 789; // Long | Requested source Id
$ignoreOperations = true; // Boolean | Hd element Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHdSourceColumns($hdId, $hdType, $id, $ignoreOperations, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->getHdSourceColumns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $id = 789; # Long | Requested source Id
my $ignoreOperations = true; # Boolean | Hd element Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHdSourceColumns(hdId => $hdId, hdType => $hdType, id => $id, ignoreOperations => $ignoreOperations, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->getHdSourceColumns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
id = 789 # Long | Requested source Id
ignoreOperations = true # Boolean | Hd element Id (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of available columns of a source
    api_response = api_instance.get_hd_source_columns(hdId, hdType, id, ignoreOperations=ignoreOperations, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->getHdSourceColumns: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
id*
Long (int64)
Requested source Id
Required
Query parameters
Name Description
ignoreOperations
Boolean
Hd element Id
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHdSources

Get a list of active sources of a hd element


/service/hd_source/{hdType}/{hdId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hd_source/{hdType}/{hdId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long project = 789; // Long | Project id
        try {
            array[HdSource] result = apiInstance.getHdSources(hdId, hdType, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long project = 789; // Long | Project id
        try {
            array[HdSource] result = apiInstance.getHdSources(hdId, hdType, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getHdSources");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Get a list of active sources of a hd element
[apiInstance getHdSourcesWith:hdId
    hdType:hdType
    project:project
              completionHandler: ^(array[HdSource] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHdSources(hdId, hdType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHdSourcesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of active sources of a hd element
                array[HdSource] result = apiInstance.getHdSources(hdId, hdType, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.getHdSources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHdSources($hdId, $hdType, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->getHdSources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHdSources(hdId => $hdId, hdType => $hdType, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->getHdSources: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
project = 789 # Long | Project id (optional)

try: 
    # Get a list of active sources of a hd element
    api_response = api_instance.get_hd_sources(hdId, hdType, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->getHdSources: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getNbrOfSourcesUsingGET

Get number of active sources of a hd element


/service/hd_source/{hdType}/{hdId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hd_source/{hdType}/{hdId}/count?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long project = 789; // Long | Project id
        try {
            'Integer' result = apiInstance.getNbrOfSourcesUsingGET(hdId, hdType, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getNbrOfSourcesUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceControllerApi;

public class HdSourceControllerApiExample {

    public static void main(String[] args) {
        HdSourceControllerApi apiInstance = new HdSourceControllerApi();
        Long hdId = 789; // Long | Hd element Id
        String hdType = hdType_example; // String | Hd element type
        Long project = 789; // Long | Project id
        try {
            'Integer' result = apiInstance.getNbrOfSourcesUsingGET(hdId, hdType, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceControllerApi#getNbrOfSourcesUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *hdId = 789; // Hd element Id
String *hdType = hdType_example; // Hd element type
Long *project = 789; // Project id (optional)

HdSourceControllerApi *apiInstance = [[HdSourceControllerApi alloc] init];

// Get number of active sources of a hd element
[apiInstance getNbrOfSourcesUsingGETWith:hdId
    hdType:hdType
    project:project
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceControllerApi()
var hdId = 789; // {{Long}} Hd element Id
var hdType = hdType_example; // {{String}} Hd element type
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNbrOfSourcesUsingGET(hdId, hdType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNbrOfSourcesUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceControllerApi();
            var hdId = 789;  // Long | Hd element Id
            var hdType = hdType_example;  // String | Hd element type
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get number of active sources of a hd element
                'Integer' result = apiInstance.getNbrOfSourcesUsingGET(hdId, hdType, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceControllerApi.getNbrOfSourcesUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceControllerApi();
$hdId = 789; // Long | Hd element Id
$hdType = hdType_example; // String | Hd element type
$project = 789; // Long | Project id

try {
    $result = $api_instance->getNbrOfSourcesUsingGET($hdId, $hdType, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceControllerApi->getNbrOfSourcesUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceControllerApi->new();
my $hdId = 789; # Long | Hd element Id
my $hdType = hdType_example; # String | Hd element type
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getNbrOfSourcesUsingGET(hdId => $hdId, hdType => $hdType, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceControllerApi->getNbrOfSourcesUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceControllerApi()
hdId = 789 # Long | Hd element Id
hdType = hdType_example # String | Hd element type
project = 789 # Long | Project id (optional)

try: 
    # Get number of active sources of a hd element
    api_response = api_instance.get_nbr_of_sources_using_get(hdId, hdType, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceControllerApi->getNbrOfSourcesUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
hdId*
Long (int64)
Hd element Id
Required
hdType*
String
Hd element type
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


HdSourceExecController

execHdSourceAndGetJobKey

Generate and execute a job in spark context basing on a DBBuilderGrammar


/service/hdsource/exec

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/hdsource/exec?clientId=&ctx=&elementId=&parentId=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceExecControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceExecControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceExecControllerApi apiInstance = new HdSourceExecControllerApi();
        SourceExecEntry body = ; // SourceExecEntry | grammar
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        Long elementId = 789; // Long | elementId
        Long parentId = 789; // Long | parentId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execHdSourceAndGetJobKey(body, clientId, ctx, elementId, parentId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceExecControllerApi#execHdSourceAndGetJobKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceExecControllerApi;

public class HdSourceExecControllerApiExample {

    public static void main(String[] args) {
        HdSourceExecControllerApi apiInstance = new HdSourceExecControllerApi();
        SourceExecEntry body = ; // SourceExecEntry | grammar
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        Long elementId = 789; // Long | elementId
        Long parentId = 789; // Long | parentId
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execHdSourceAndGetJobKey(body, clientId, ctx, elementId, parentId, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceExecControllerApi#execHdSourceAndGetJobKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
SourceExecEntry *body = ; // grammar
String *clientId = clientId_example; // clientId (optional)
Integer *ctx = 56; // ctx (optional)
Long *elementId = 789; // elementId (optional)
Long *parentId = 789; // parentId (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

HdSourceExecControllerApi *apiInstance = [[HdSourceExecControllerApi alloc] init];

// Generate and execute a job in spark context basing on a DBBuilderGrammar
[apiInstance execHdSourceAndGetJobKeyWith:body
    clientId:clientId
    ctx:ctx
    elementId:elementId
    parentId:parentId
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceExecControllerApi()
var body = ; // {{SourceExecEntry}} grammar
var opts = { 
  'clientId': clientId_example // {{String}} clientId
  'ctx': 56 // {{Integer}} ctx
  'elementId': 789 // {{Long}} elementId
  'parentId': 789 // {{Long}} parentId
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.execHdSourceAndGetJobKey(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class execHdSourceAndGetJobKeyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceExecControllerApi();
            var body = new SourceExecEntry(); // SourceExecEntry | grammar
            var clientId = clientId_example;  // String | clientId (optional) 
            var ctx = 56;  // Integer | ctx (optional) 
            var elementId = 789;  // Long | elementId (optional) 
            var parentId = 789;  // Long | parentId (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Generate and execute a job in spark context basing on a DBBuilderGrammar
                JobKeyResponse result = apiInstance.execHdSourceAndGetJobKey(body, clientId, ctx, elementId, parentId, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceExecControllerApi.execHdSourceAndGetJobKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceExecControllerApi();
$body = ; // SourceExecEntry | grammar
$clientId = clientId_example; // String | clientId
$ctx = 56; // Integer | ctx
$elementId = 789; // Long | elementId
$parentId = 789; // Long | parentId
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->execHdSourceAndGetJobKey($body, $clientId, $ctx, $elementId, $parentId, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceExecControllerApi->execHdSourceAndGetJobKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceExecControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceExecControllerApi->new();
my $body = WWW::SwaggerClient::Object::SourceExecEntry->new(); # SourceExecEntry | grammar
my $clientId = clientId_example; # String | clientId
my $ctx = 56; # Integer | ctx
my $elementId = 789; # Long | elementId
my $parentId = 789; # Long | parentId
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->execHdSourceAndGetJobKey(body => $body, clientId => $clientId, ctx => $ctx, elementId => $elementId, parentId => $parentId, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceExecControllerApi->execHdSourceAndGetJobKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceExecControllerApi()
body =  # SourceExecEntry | grammar
clientId = clientId_example # String | clientId (optional)
ctx = 56 # Integer | ctx (optional)
elementId = 789 # Long | elementId (optional)
parentId = 789 # Long | parentId (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Generate and execute a job in spark context basing on a DBBuilderGrammar
    api_response = api_instance.exec_hd_source_and_get_job_key(body, clientId=clientId, ctx=ctx, elementId=elementId, parentId=parentId, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceExecControllerApi->execHdSourceAndGetJobKey: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
clientId
String
clientId
ctx
Integer (int32)
ctx
elementId
Long (int64)
elementId
parentId
Long (int64)
parentId
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHdSourceDataByJobKey

Generate and execute a job in spark context basing on a DBBuilderGrammar


/service/hdsource/exec/result

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/hdsource/exec/result?ctx=&jobKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdSourceExecControllerApi;

import java.io.File;
import java.util.*;

public class HdSourceExecControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdSourceExecControllerApi apiInstance = new HdSourceExecControllerApi();
        String jobKey = jobKey_example; // String | jobKey
        Integer ctx = 56; // Integer | ctx
        try {
            ExecDataResult result = apiInstance.getHdSourceDataByJobKey(jobKey, ctx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceExecControllerApi#getHdSourceDataByJobKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdSourceExecControllerApi;

public class HdSourceExecControllerApiExample {

    public static void main(String[] args) {
        HdSourceExecControllerApi apiInstance = new HdSourceExecControllerApi();
        String jobKey = jobKey_example; // String | jobKey
        Integer ctx = 56; // Integer | ctx
        try {
            ExecDataResult result = apiInstance.getHdSourceDataByJobKey(jobKey, ctx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdSourceExecControllerApi#getHdSourceDataByJobKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *jobKey = jobKey_example; // jobKey
Integer *ctx = 56; // ctx (optional)

HdSourceExecControllerApi *apiInstance = [[HdSourceExecControllerApi alloc] init];

// Generate and execute a job in spark context basing on a DBBuilderGrammar
[apiInstance getHdSourceDataByJobKeyWith:jobKey
    ctx:ctx
              completionHandler: ^(ExecDataResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdSourceExecControllerApi()
var jobKey = jobKey_example; // {{String}} jobKey
var opts = { 
  'ctx': 56 // {{Integer}} ctx
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHdSourceDataByJobKey(jobKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHdSourceDataByJobKeyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdSourceExecControllerApi();
            var jobKey = jobKey_example;  // String | jobKey
            var ctx = 56;  // Integer | ctx (optional) 

            try
            {
                // Generate and execute a job in spark context basing on a DBBuilderGrammar
                ExecDataResult result = apiInstance.getHdSourceDataByJobKey(jobKey, ctx);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdSourceExecControllerApi.getHdSourceDataByJobKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdSourceExecControllerApi();
$jobKey = jobKey_example; // String | jobKey
$ctx = 56; // Integer | ctx

try {
    $result = $api_instance->getHdSourceDataByJobKey($jobKey, $ctx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdSourceExecControllerApi->getHdSourceDataByJobKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdSourceExecControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdSourceExecControllerApi->new();
my $jobKey = jobKey_example; # String | jobKey
my $ctx = 56; # Integer | ctx

eval { 
    my $result = $api_instance->getHdSourceDataByJobKey(jobKey => $jobKey, ctx => $ctx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdSourceExecControllerApi->getHdSourceDataByJobKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdSourceExecControllerApi()
jobKey = jobKey_example # String | jobKey
ctx = 56 # Integer | ctx (optional)

try: 
    # Generate and execute a job in spark context basing on a DBBuilderGrammar
    api_response = api_instance.get_hd_source_data_by_job_key(jobKey, ctx=ctx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdSourceExecControllerApi->getHdSourceDataByJobKey: %s\n" % e)

Parameters

Query parameters
Name Description
ctx
Integer (int32)
ctx
jobKey*
String
jobKey
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


HdfsConnectorController

checkSftpConnection

Check a HDFS connector connectivity


/service/connectors/hdfs/check_connection

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/hdfs/check_connection?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hdfsConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkSftpConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#checkSftpConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hdfsConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkSftpConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#checkSftpConnection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HDFSConnector *body = ; // hdfsConnector
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// Check a HDFS connector connectivity
[apiInstance checkSftpConnectionWith:body
    ctx:ctx
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var body = ; // {{HDFSConnector}} hdfsConnector
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkSftpConnection(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkSftpConnectionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var body = new HDFSConnector(); // HDFSConnector | hdfsConnector
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check a HDFS connector connectivity
                'Boolean' result = apiInstance.checkSftpConnection(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.checkSftpConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$body = ; // HDFSConnector | hdfsConnector
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkSftpConnection($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->checkSftpConnection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HDFSConnector->new(); # HDFSConnector | hdfsConnector
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkSftpConnection(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->checkSftpConnection: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
body =  # HDFSConnector | hdfsConnector
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Check a HDFS connector connectivity
    api_response = api_instance.check_sftp_connection(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->checkSftpConnection: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createHDFSConnector

Create a new HDFS connector

Create a new HDFS connector and return the created object


/service/connectors/hdfs

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/hdfs?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hDFSConnector
        Long project = 789; // Long | Project id
        try {
            HDFSConnector result = apiInstance.createHDFSConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#createHDFSConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hDFSConnector
        Long project = 789; // Long | Project id
        try {
            HDFSConnector result = apiInstance.createHDFSConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#createHDFSConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HDFSConnector *body = ; // hDFSConnector
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// Create a new HDFS connector
[apiInstance createHDFSConnectorWith:body
    project:project
              completionHandler: ^(HDFSConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var body = ; // {{HDFSConnector}} hDFSConnector
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHDFSConnector(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createHDFSConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var body = new HDFSConnector(); // HDFSConnector | hDFSConnector
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new HDFS connector
                HDFSConnector result = apiInstance.createHDFSConnector(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.createHDFSConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$body = ; // HDFSConnector | hDFSConnector
$project = 789; // Long | Project id

try {
    $result = $api_instance->createHDFSConnector($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->createHDFSConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HDFSConnector->new(); # HDFSConnector | hDFSConnector
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createHDFSConnector(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->createHDFSConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
body =  # HDFSConnector | hDFSConnector
project = 789 # Long | Project id (optional)

try: 
    # Create a new HDFS connector
    api_response = api_instance.create_hdfs_connector(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->createHDFSConnector: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteHDFSConnector

Delete a HDFS connector

Delete an existing HDFS connector for a given ID and return the delete object ID


/service/connectors/hdfs/{connectorId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/connectors/hdfs/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteHDFSConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#deleteHDFSConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteHDFSConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#deleteHDFSConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// Delete a HDFS connector
[apiInstance deleteHDFSConnectorWith:connectorId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteHDFSConnector(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteHDFSConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a HDFS connector
                apiInstance.deleteHDFSConnector(connectorId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.deleteHDFSConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $api_instance->deleteHDFSConnector($connectorId, $project);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->deleteHDFSConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteHDFSConnector(connectorId => $connectorId, project => $project);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->deleteHDFSConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Delete a HDFS connector
    api_instance.delete_hdfs_connector(connectorId, project=project)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->deleteHDFSConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editHDFSConnector

Edit a HDFS connector

Edit an existing HDFS connector and return the updated object


/service/connectors/hdfs/{connectorId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/hdfs/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hDFSConnector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HDFSConnector result = apiInstance.editHDFSConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#editHDFSConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hDFSConnector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HDFSConnector result = apiInstance.editHDFSConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#editHDFSConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HDFSConnector *body = ; // hDFSConnector
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// Edit a HDFS connector
[apiInstance editHDFSConnectorWith:body
    connectorId:connectorId
    project:project
              completionHandler: ^(HDFSConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var body = ; // {{HDFSConnector}} hDFSConnector
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editHDFSConnector(bodyconnectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editHDFSConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var body = new HDFSConnector(); // HDFSConnector | hDFSConnector
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a HDFS connector
                HDFSConnector result = apiInstance.editHDFSConnector(body, connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.editHDFSConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$body = ; // HDFSConnector | hDFSConnector
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editHDFSConnector($body, $connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->editHDFSConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HDFSConnector->new(); # HDFSConnector | hDFSConnector
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editHDFSConnector(body => $body, connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->editHDFSConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
body =  # HDFSConnector | hDFSConnector
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Edit a HDFS connector
    api_response = api_instance.edit_hdfs_connector(body, connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->editHDFSConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllHDFSConnectors

View a list of HDFS connectors


/service/connectors/hdfs

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/hdfs?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[HDFSConnector] result = apiInstance.findAllHDFSConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#findAllHDFSConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[HDFSConnector] result = apiInstance.findAllHDFSConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#findAllHDFSConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// View a list of HDFS connectors
[apiInstance findAllHDFSConnectorsWith:project
              completionHandler: ^(array[HDFSConnector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllHDFSConnectors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllHDFSConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of HDFS connectors
                array[HDFSConnector] result = apiInstance.findAllHDFSConnectors(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.findAllHDFSConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllHDFSConnectors($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->findAllHDFSConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllHDFSConnectors(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->findAllHDFSConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of HDFS connectors
    api_response = api_instance.find_all_hdfs_connectors(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->findAllHDFSConnectors: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneHDFSConnectorById

Get a HDFS connector by ID


/service/connectors/hdfs/{connectorId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/hdfs/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HDFSConnector result = apiInstance.findOneHDFSConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#findOneHDFSConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HDFSConnector result = apiInstance.findOneHDFSConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#findOneHDFSConnectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// Get a HDFS connector by ID
[apiInstance findOneHDFSConnectorByIdWith:connectorId
    project:project
              completionHandler: ^(HDFSConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneHDFSConnectorById(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneHDFSConnectorByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a HDFS connector by ID
                HDFSConnector result = apiInstance.findOneHDFSConnectorById(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.findOneHDFSConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneHDFSConnectorById($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->findOneHDFSConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneHDFSConnectorById(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->findOneHDFSConnectorById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Get a HDFS connector by ID
    api_response = api_instance.find_one_hdfs_connector_by_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->findOneHDFSConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listHDFSRemoteFiles

List HDFS remote files


/service/connectors/files/hdfs

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/files/hdfs?ctx=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hdfsConnector
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listHDFSRemoteFiles(body, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#listHDFSRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        HDFSConnector body = ; // HDFSConnector | hdfsConnector
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listHDFSRemoteFiles(body, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#listHDFSRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HDFSConnector *body = ; // hdfsConnector
Integer *ctx = 56; // ctx
String *remotePath = remotePath_example; // remotePath
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// List HDFS remote files
[apiInstance listHDFSRemoteFilesWith:body
    ctx:ctx
    remotePath:remotePath
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var body = ; // {{HDFSConnector}} hdfsConnector
var ctx = 56; // {{Integer}} ctx
var remotePath = remotePath_example; // {{String}} remotePath
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listHDFSRemoteFiles(bodyctxremotePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listHDFSRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var body = new HDFSConnector(); // HDFSConnector | hdfsConnector
            var ctx = 56;  // Integer | ctx
            var remotePath = remotePath_example;  // String | remotePath
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // List HDFS remote files
                'Boolean' result = apiInstance.listHDFSRemoteFiles(body, ctx, remotePath, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.listHDFSRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$body = ; // HDFSConnector | hdfsConnector
$ctx = 56; // Integer | ctx
$remotePath = remotePath_example; // String | remotePath
$project = 789; // Long | Project id

try {
    $result = $api_instance->listHDFSRemoteFiles($body, $ctx, $remotePath, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->listHDFSRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HDFSConnector->new(); # HDFSConnector | hdfsConnector
my $ctx = 56; # Integer | ctx
my $remotePath = remotePath_example; # String | remotePath
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listHDFSRemoteFiles(body => $body, ctx => $ctx, remotePath => $remotePath, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->listHDFSRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
body =  # HDFSConnector | hdfsConnector
ctx = 56 # Integer | ctx
remotePath = remotePath_example # String | remotePath
project = 789 # Long | Project id (optional)

try: 
    # List HDFS remote files
    api_response = api_instance.list_hdfs_remote_files(body, ctx, remotePath, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->listHDFSRemoteFiles: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
remotePath*
String
remotePath
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listHDFSRemoteFilesById

List HDFS remote files by id


/service/connectors/hdfs/{connectorId}/files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/hdfs/{connectorId}/files?ctx=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HdfsConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listHDFSRemoteFilesById(connectorId, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#listHDFSRemoteFilesById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HdfsConnectorControllerApi;

public class HdfsConnectorControllerApiExample {

    public static void main(String[] args) {
        HdfsConnectorControllerApi apiInstance = new HdfsConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listHDFSRemoteFilesById(connectorId, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HdfsConnectorControllerApi#listHDFSRemoteFilesById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Integer *ctx = 56; // ctx
String *remotePath = remotePath_example; // remotePath
Long *project = 789; // Project id (optional)

HdfsConnectorControllerApi *apiInstance = [[HdfsConnectorControllerApi alloc] init];

// List HDFS remote files by id
[apiInstance listHDFSRemoteFilesByIdWith:connectorId
    ctx:ctx
    remotePath:remotePath
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HdfsConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var ctx = 56; // {{Integer}} ctx
var remotePath = remotePath_example; // {{String}} remotePath
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listHDFSRemoteFilesById(connectorId, ctx, remotePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listHDFSRemoteFilesByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HdfsConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var ctx = 56;  // Integer | ctx
            var remotePath = remotePath_example;  // String | remotePath
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // List HDFS remote files by id
                'Boolean' result = apiInstance.listHDFSRemoteFilesById(connectorId, ctx, remotePath, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HdfsConnectorControllerApi.listHDFSRemoteFilesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHdfsConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$ctx = 56; // Integer | ctx
$remotePath = remotePath_example; // String | remotePath
$project = 789; // Long | Project id

try {
    $result = $api_instance->listHDFSRemoteFilesById($connectorId, $ctx, $remotePath, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HdfsConnectorControllerApi->listHDFSRemoteFilesById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HdfsConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HdfsConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $ctx = 56; # Integer | ctx
my $remotePath = remotePath_example; # String | remotePath
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listHDFSRemoteFilesById(connectorId => $connectorId, ctx => $ctx, remotePath => $remotePath, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HdfsConnectorControllerApi->listHDFSRemoteFilesById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HdfsConnectorControllerApi()
connectorId = 789 # Long | connectorId
ctx = 56 # Integer | ctx
remotePath = remotePath_example # String | remotePath
project = 789 # Long | Project id (optional)

try: 
    # List HDFS remote files by id
    api_response = api_instance.list_hdfs_remote_files_by_id(connectorId, ctx, remotePath, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HdfsConnectorControllerApi->listHDFSRemoteFilesById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
remotePath*
String
remotePath
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


HttpConnectorController

checkHTTPConnection

Check an HTTP connector connectivity


/service/connectors/http/check_connection

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/http/check_connection?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HttpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        HTTPConnector body = ; // HTTPConnector | httpConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkHTTPConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#checkHTTPConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HttpConnectorControllerApi;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        HTTPConnector body = ; // HTTPConnector | httpConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkHTTPConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#checkHTTPConnection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HTTPConnector *body = ; // httpConnector
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

HttpConnectorControllerApi *apiInstance = [[HttpConnectorControllerApi alloc] init];

// Check an HTTP connector connectivity
[apiInstance checkHTTPConnectionWith:body
    ctx:ctx
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HttpConnectorControllerApi()
var body = ; // {{HTTPConnector}} httpConnector
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkHTTPConnection(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkHTTPConnectionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HttpConnectorControllerApi();
            var body = new HTTPConnector(); // HTTPConnector | httpConnector
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check an HTTP connector connectivity
                'Boolean' result = apiInstance.checkHTTPConnection(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HttpConnectorControllerApi.checkHTTPConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHttpConnectorControllerApi();
$body = ; // HTTPConnector | httpConnector
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkHTTPConnection($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HttpConnectorControllerApi->checkHTTPConnection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HttpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HttpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HTTPConnector->new(); # HTTPConnector | httpConnector
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkHTTPConnection(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HttpConnectorControllerApi->checkHTTPConnection: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HttpConnectorControllerApi()
body =  # HTTPConnector | httpConnector
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Check an HTTP connector connectivity
    api_response = api_instance.check_http_connection(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HttpConnectorControllerApi->checkHTTPConnection: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createHTTPConnector

Create a new HTTP connector

Create a new HTTP connector and return the created object


/service/connectors/http

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/http?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HttpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        HTTPConnector body = ; // HTTPConnector | connector
        Long project = 789; // Long | Project id
        try {
            HTTPConnector result = apiInstance.createHTTPConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#createHTTPConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HttpConnectorControllerApi;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        HTTPConnector body = ; // HTTPConnector | connector
        Long project = 789; // Long | Project id
        try {
            HTTPConnector result = apiInstance.createHTTPConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#createHTTPConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HTTPConnector *body = ; // connector
Long *project = 789; // Project id (optional)

HttpConnectorControllerApi *apiInstance = [[HttpConnectorControllerApi alloc] init];

// Create a new HTTP connector
[apiInstance createHTTPConnectorWith:body
    project:project
              completionHandler: ^(HTTPConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HttpConnectorControllerApi()
var body = ; // {{HTTPConnector}} connector
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHTTPConnector(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createHTTPConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HttpConnectorControllerApi();
            var body = new HTTPConnector(); // HTTPConnector | connector
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new HTTP connector
                HTTPConnector result = apiInstance.createHTTPConnector(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HttpConnectorControllerApi.createHTTPConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHttpConnectorControllerApi();
$body = ; // HTTPConnector | connector
$project = 789; // Long | Project id

try {
    $result = $api_instance->createHTTPConnector($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HttpConnectorControllerApi->createHTTPConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HttpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HttpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HTTPConnector->new(); # HTTPConnector | connector
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createHTTPConnector(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HttpConnectorControllerApi->createHTTPConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HttpConnectorControllerApi()
body =  # HTTPConnector | connector
project = 789 # Long | Project id (optional)

try: 
    # Create a new HTTP connector
    api_response = api_instance.create_http_connector(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HttpConnectorControllerApi->createHTTPConnector: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteHTTPConnector

Delete an HTTP connector

Delete an existing HTTP connector for a given ID and return the delete object ID


/service/connectors/http/{connectorId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/connectors/http/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HttpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteHTTPConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#deleteHTTPConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HttpConnectorControllerApi;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteHTTPConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#deleteHTTPConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

HttpConnectorControllerApi *apiInstance = [[HttpConnectorControllerApi alloc] init];

// Delete an HTTP connector
[apiInstance deleteHTTPConnectorWith:connectorId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HttpConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteHTTPConnector(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteHTTPConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HttpConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an HTTP connector
                apiInstance.deleteHTTPConnector(connectorId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HttpConnectorControllerApi.deleteHTTPConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHttpConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $api_instance->deleteHTTPConnector($connectorId, $project);
} catch (Exception $e) {
    echo 'Exception when calling HttpConnectorControllerApi->deleteHTTPConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HttpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HttpConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteHTTPConnector(connectorId => $connectorId, project => $project);
};
if ($@) {
    warn "Exception when calling HttpConnectorControllerApi->deleteHTTPConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HttpConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Delete an HTTP connector
    api_instance.delete_http_connector(connectorId, project=project)
except ApiException as e:
    print("Exception when calling HttpConnectorControllerApi->deleteHTTPConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editHTTPConnector

Edit an HTTP connector

Edit an existing HTTP connector and return the updated object


/service/connectors/http/{connectorId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/http/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HttpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        HTTPConnector body = ; // HTTPConnector | connector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HTTPConnector result = apiInstance.editHTTPConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#editHTTPConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HttpConnectorControllerApi;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        HTTPConnector body = ; // HTTPConnector | connector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HTTPConnector result = apiInstance.editHTTPConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#editHTTPConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
HTTPConnector *body = ; // connector
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

HttpConnectorControllerApi *apiInstance = [[HttpConnectorControllerApi alloc] init];

// Edit an HTTP connector
[apiInstance editHTTPConnectorWith:body
    connectorId:connectorId
    project:project
              completionHandler: ^(HTTPConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HttpConnectorControllerApi()
var body = ; // {{HTTPConnector}} connector
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editHTTPConnector(bodyconnectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editHTTPConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HttpConnectorControllerApi();
            var body = new HTTPConnector(); // HTTPConnector | connector
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit an HTTP connector
                HTTPConnector result = apiInstance.editHTTPConnector(body, connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HttpConnectorControllerApi.editHTTPConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHttpConnectorControllerApi();
$body = ; // HTTPConnector | connector
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editHTTPConnector($body, $connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HttpConnectorControllerApi->editHTTPConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HttpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HttpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::HTTPConnector->new(); # HTTPConnector | connector
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editHTTPConnector(body => $body, connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HttpConnectorControllerApi->editHTTPConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HttpConnectorControllerApi()
body =  # HTTPConnector | connector
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Edit an HTTP connector
    api_response = api_instance.edit_http_connector(body, connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HttpConnectorControllerApi->editHTTPConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllHTTPConnectors

View a list of HTTP connectors


/service/connectors/http

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/http?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HttpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[HTTPConnector] result = apiInstance.findAllHTTPConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#findAllHTTPConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HttpConnectorControllerApi;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[HTTPConnector] result = apiInstance.findAllHTTPConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#findAllHTTPConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

HttpConnectorControllerApi *apiInstance = [[HttpConnectorControllerApi alloc] init];

// View a list of HTTP connectors
[apiInstance findAllHTTPConnectorsWith:project
              completionHandler: ^(array[HTTPConnector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HttpConnectorControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllHTTPConnectors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllHTTPConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HttpConnectorControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of HTTP connectors
                array[HTTPConnector] result = apiInstance.findAllHTTPConnectors(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HttpConnectorControllerApi.findAllHTTPConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHttpConnectorControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllHTTPConnectors($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HttpConnectorControllerApi->findAllHTTPConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HttpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HttpConnectorControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllHTTPConnectors(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HttpConnectorControllerApi->findAllHTTPConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HttpConnectorControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of HTTP connectors
    api_response = api_instance.find_all_http_connectors(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HttpConnectorControllerApi->findAllHTTPConnectors: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneHTTPConnectorById

Get an HTTP connector by ID


/service/connectors/http/{connectorId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/http/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HttpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HTTPConnector result = apiInstance.findOneHTTPConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#findOneHTTPConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HttpConnectorControllerApi;

public class HttpConnectorControllerApiExample {

    public static void main(String[] args) {
        HttpConnectorControllerApi apiInstance = new HttpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            HTTPConnector result = apiInstance.findOneHTTPConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpConnectorControllerApi#findOneHTTPConnectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

HttpConnectorControllerApi *apiInstance = [[HttpConnectorControllerApi alloc] init];

// Get an HTTP connector by ID
[apiInstance findOneHTTPConnectorByIdWith:connectorId
    project:project
              completionHandler: ^(HTTPConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.HttpConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneHTTPConnectorById(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneHTTPConnectorByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HttpConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get an HTTP connector by ID
                HTTPConnector result = apiInstance.findOneHTTPConnectorById(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HttpConnectorControllerApi.findOneHTTPConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHttpConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneHTTPConnectorById($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HttpConnectorControllerApi->findOneHTTPConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HttpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HttpConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneHTTPConnectorById(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HttpConnectorControllerApi->findOneHTTPConnectorById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HttpConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Get an HTTP connector by ID
    api_response = api_instance.find_one_http_connector_by_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HttpConnectorControllerApi->findOneHTTPConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ImageMediaController

checkConfigUsingGET5

Check the configuration informations of an existing media


/service/medias/image/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/image/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET5(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#checkConfigUsingGET5");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET5(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#checkConfigUsingGET5");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdMedia Id
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Check the configuration informations of an existing media
[apiInstance checkConfigUsingGET5With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var id = 789; // {{Long}} HdMedia Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET5(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET5Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var id = 789;  // Long | HdMedia Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing media
                'Boolean' result = apiInstance.checkConfigUsingGET5(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.checkConfigUsingGET5: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$id = 789; // Long | HdMedia Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET5($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->checkConfigUsingGET5: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $id = 789; # Long | HdMedia Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET5(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->checkConfigUsingGET5: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
id = 789 # Long | HdMedia Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing media
    api_response = api_instance.check_config_using_get5(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->checkConfigUsingGET5: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMedia Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createImageMedia

Create a new media

Create a new media and returns the new generated id


/service/medias/image

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/image?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        CreateMediaEntry body = ; // CreateMediaEntry | media
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createImageMedia(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#createImageMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        CreateMediaEntry body = ; // CreateMediaEntry | media
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createImageMedia(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#createImageMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateMediaEntry *body = ; // media
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Create a new media
[apiInstance createImageMediaWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var body = ; // {{CreateMediaEntry}} media
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createImageMedia(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createImageMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var body = new CreateMediaEntry(); // CreateMediaEntry | media
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new media
                Long result = apiInstance.createImageMedia(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.createImageMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$body = ; // CreateMediaEntry | media
$project = 789; // Long | Project id

try {
    $result = $api_instance->createImageMedia($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->createImageMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateMediaEntry->new(); # CreateMediaEntry | media
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createImageMedia(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->createImageMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
body =  # CreateMediaEntry | media
project = 789 # Long | Project id (optional)

try: 
    # Create a new media
    api_response = api_instance.create_image_media(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->createImageMedia: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createImageMediaFromDb

Create a new media from datablock

Create a new media from datablock and returns the new generated id


/service/medias/image/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/image/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        CreateMediaFromDbEntry body = ; // CreateMediaFromDbEntry | the new media data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createImageMediaFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#createImageMediaFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        CreateMediaFromDbEntry body = ; // CreateMediaFromDbEntry | the new media data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createImageMediaFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#createImageMediaFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateMediaFromDbEntry *body = ; // the new media data
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Create a new media from datablock
[apiInstance createImageMediaFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var body = ; // {{CreateMediaFromDbEntry}} the new media data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createImageMediaFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createImageMediaFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var body = new CreateMediaFromDbEntry(); // CreateMediaFromDbEntry | the new media data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new media from datablock
                Long result = apiInstance.createImageMediaFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.createImageMediaFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$body = ; // CreateMediaFromDbEntry | the new media data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createImageMediaFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->createImageMediaFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateMediaFromDbEntry->new(); # CreateMediaFromDbEntry | the new media data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createImageMediaFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->createImageMediaFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
body =  # CreateMediaFromDbEntry | the new media data
project = 789 # Long | Project id (optional)

try: 
    # Create a new media from datablock
    api_response = api_instance.create_image_media_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->createImageMediaFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteImageMedia

Delete an existing media


/service/medias/image/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/medias/image/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteImageMedia(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#deleteImageMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteImageMedia(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#deleteImageMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the media to be deleted
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Delete an existing media
[apiInstance deleteImageMediaWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var id = 789; // {{Long}} The Id of the media to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteImageMedia(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteImageMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var id = 789;  // Long | The Id of the media to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing media
                apiInstance.deleteImageMedia(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.deleteImageMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$id = 789; // Long | The Id of the media to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteImageMedia($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->deleteImageMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $id = 789; # Long | The Id of the media to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteImageMedia(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->deleteImageMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
id = 789 # Long | The Id of the media to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing media
    api_instance.delete_image_media(id, project=project)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->deleteImageMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the media to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateImageMedia

Duplicate an existing media


/service/medias/image/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/medias/image/{id}/duplicate?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateImageMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#duplicateImageMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateImageMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#duplicateImageMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the media to be duplicated
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Duplicate an existing media
[apiInstance duplicateImageMediaWith:id
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var id = 789; // {{Long}} The Id of the media to be duplicated
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateImageMedia(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateImageMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var id = 789;  // Long | The Id of the media to be duplicated
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Duplicate an existing media
                Long result = apiInstance.duplicateImageMedia(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.duplicateImageMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$id = 789; // Long | The Id of the media to be duplicated
$project = 789; // Long | Project id

try {
    $result = $api_instance->duplicateImageMedia($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->duplicateImageMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $id = 789; # Long | The Id of the media to be duplicated
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->duplicateImageMedia(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->duplicateImageMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
id = 789 # Long | The Id of the media to be duplicated
project = 789 # Long | Project id (optional)

try: 
    # Duplicate an existing media
    api_response = api_instance.duplicate_image_media(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->duplicateImageMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the media to be duplicated
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editImageMedia

Edit media

Edit an existing media


/service/medias/image/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/image/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        UpdateMediaEntry body = ; // UpdateMediaEntry | Update media data
        Long id = 789; // Long | Id of media to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editImageMedia(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#editImageMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        UpdateMediaEntry body = ; // UpdateMediaEntry | Update media data
        Long id = 789; // Long | Id of media to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editImageMedia(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#editImageMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateMediaEntry *body = ; // Update media data
Long *id = 789; // Id of media to update data
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Edit media
[apiInstance editImageMediaWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var body = ; // {{UpdateMediaEntry}} Update media data
var id = 789; // {{Long}} Id of media to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editImageMedia(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editImageMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var body = new UpdateMediaEntry(); // UpdateMediaEntry | Update media data
            var id = 789;  // Long | Id of media to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit media
                apiInstance.editImageMedia(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.editImageMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$body = ; // UpdateMediaEntry | Update media data
$id = 789; // Long | Id of media to update data
$project = 789; // Long | Project id

try {
    $api_instance->editImageMedia($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->editImageMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateMediaEntry->new(); # UpdateMediaEntry | Update media data
my $id = 789; # Long | Id of media to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editImageMedia(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->editImageMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
body =  # UpdateMediaEntry | Update media data
id = 789 # Long | Id of media to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit media
    api_instance.edit_image_media(body, id, project=project)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->editImageMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of media to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editImageMediaConfig

Update the configuration informations of an existing media


/service/medias/image/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/image/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        UpdateImageMediaConfigEntry body = ; // UpdateImageMediaConfigEntry | The update configuration data
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editImageMediaConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#editImageMediaConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        UpdateImageMediaConfigEntry body = ; // UpdateImageMediaConfigEntry | The update configuration data
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editImageMediaConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#editImageMediaConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateImageMediaConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdMedia Id
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Update the configuration informations of an existing media
[apiInstance editImageMediaConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var body = ; // {{UpdateImageMediaConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdMedia Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editImageMediaConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editImageMediaConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var body = new UpdateImageMediaConfigEntry(); // UpdateImageMediaConfigEntry | The update configuration data
            var id = 789;  // Long | HdMedia Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing media
                apiInstance.editImageMediaConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.editImageMediaConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$body = ; // UpdateImageMediaConfigEntry | The update configuration data
$id = 789; // Long | HdMedia Id
$project = 789; // Long | Project id

try {
    $api_instance->editImageMediaConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->editImageMediaConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateImageMediaConfigEntry->new(); # UpdateImageMediaConfigEntry | The update configuration data
my $id = 789; # Long | HdMedia Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editImageMediaConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->editImageMediaConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
body =  # UpdateImageMediaConfigEntry | The update configuration data
id = 789 # Long | HdMedia Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing media
    api_instance.edit_image_media_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->editImageMediaConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMedia Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getImageMedia

Get a media by Id


/service/medias/image/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/image/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | Requested media Id
        Long project = 789; // Long | Project id
        try {
            HdMedia result = apiInstance.getImageMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#getImageMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | Requested media Id
        Long project = 789; // Long | Project id
        try {
            HdMedia result = apiInstance.getImageMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#getImageMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested media Id
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Get a media by Id
[apiInstance getImageMediaWith:id
    project:project
              completionHandler: ^(HdMedia output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var id = 789; // {{Long}} Requested media Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImageMedia(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImageMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var id = 789;  // Long | Requested media Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a media by Id
                HdMedia result = apiInstance.getImageMedia(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.getImageMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$id = 789; // Long | Requested media Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getImageMedia($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->getImageMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $id = 789; # Long | Requested media Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getImageMedia(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->getImageMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
id = 789 # Long | Requested media Id
project = 789 # Long | Project id (optional)

try: 
    # Get a media by Id
    api_response = api_instance.get_image_media(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->getImageMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested media Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getImageMediaConfig

Get the configuration informations of an existing media


/service/medias/image/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/image/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImageMediaControllerApi;

import java.io.File;
import java.util.*;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            ImageMediaConfig result = apiInstance.getImageMediaConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#getImageMediaConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImageMediaControllerApi;

public class ImageMediaControllerApiExample {

    public static void main(String[] args) {
        ImageMediaControllerApi apiInstance = new ImageMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            ImageMediaConfig result = apiInstance.getImageMediaConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageMediaControllerApi#getImageMediaConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdMedia Id
Long *project = 789; // Project id (optional)

ImageMediaControllerApi *apiInstance = [[ImageMediaControllerApi alloc] init];

// Get the configuration informations of an existing media
[apiInstance getImageMediaConfigWith:id
    project:project
              completionHandler: ^(ImageMediaConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ImageMediaControllerApi()
var id = 789; // {{Long}} HdMedia Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImageMediaConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImageMediaConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ImageMediaControllerApi();
            var id = 789;  // Long | HdMedia Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing media
                ImageMediaConfig result = apiInstance.getImageMediaConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImageMediaControllerApi.getImageMediaConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiImageMediaControllerApi();
$id = 789; // Long | HdMedia Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getImageMediaConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageMediaControllerApi->getImageMediaConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImageMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ImageMediaControllerApi->new();
my $id = 789; # Long | HdMedia Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getImageMediaConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageMediaControllerApi->getImageMediaConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ImageMediaControllerApi()
id = 789 # Long | HdMedia Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing media
    api_response = api_instance.get_image_media_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageMediaControllerApi->getImageMediaConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMedia Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


IndicatorChartController

checkConfigUsingGET6

Check the configuration informations of an existing chart


/service/charts/indicator/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/indicator/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET6(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#checkConfigUsingGET6");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET6(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#checkConfigUsingGET6");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET6With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET6(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET6Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET6(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.checkConfigUsingGET6: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET6($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->checkConfigUsingGET6: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET6(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->checkConfigUsingGET6: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get6(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->checkConfigUsingGET6: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createIndicatorChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/indicator

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/indicator?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createIndicatorChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#createIndicatorChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createIndicatorChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#createIndicatorChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Create a new chart
[apiInstance createIndicatorChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createIndicatorChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createIndicatorChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createIndicatorChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.createIndicatorChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createIndicatorChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->createIndicatorChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createIndicatorChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->createIndicatorChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_indicator_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->createIndicatorChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createIndicatorChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/indicator/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/indicator/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createIndicatorChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#createIndicatorChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createIndicatorChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#createIndicatorChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createIndicatorChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createIndicatorChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createIndicatorChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createIndicatorChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.createIndicatorChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createIndicatorChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->createIndicatorChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createIndicatorChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->createIndicatorChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_indicator_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->createIndicatorChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteIndicatorChart

Delete an existing chart


/service/charts/indicator/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/indicator/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteIndicatorChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#deleteIndicatorChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteIndicatorChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#deleteIndicatorChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteIndicatorChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteIndicatorChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteIndicatorChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteIndicatorChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.deleteIndicatorChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteIndicatorChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->deleteIndicatorChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteIndicatorChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->deleteIndicatorChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_indicator_chart(id, project=project)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->deleteIndicatorChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateIndicatorChart

Duplicate an existing chart


/service/charts/indicator/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/indicator/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateIndicatorChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#duplicateIndicatorChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateIndicatorChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#duplicateIndicatorChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateIndicatorChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateIndicatorChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateIndicatorChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateIndicatorChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.duplicateIndicatorChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateIndicatorChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->duplicateIndicatorChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateIndicatorChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->duplicateIndicatorChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_indicator_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->duplicateIndicatorChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editIndicatorChart

Edit chart

Edit an existing chart


/service/charts/indicator/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/indicator/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editIndicatorChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#editIndicatorChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editIndicatorChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#editIndicatorChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Edit chart
[apiInstance editIndicatorChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editIndicatorChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editIndicatorChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editIndicatorChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.editIndicatorChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editIndicatorChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->editIndicatorChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editIndicatorChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->editIndicatorChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_indicator_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->editIndicatorChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editIndicatorChartConfig

Update the configuration informations of an existing chart


/service/charts/indicator/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/indicator/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        UpdateIndicatorChartConfigEntry body = ; // UpdateIndicatorChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editIndicatorChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#editIndicatorChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        UpdateIndicatorChartConfigEntry body = ; // UpdateIndicatorChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editIndicatorChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#editIndicatorChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateIndicatorChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editIndicatorChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var body = ; // {{UpdateIndicatorChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editIndicatorChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editIndicatorChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var body = new UpdateIndicatorChartConfigEntry(); // UpdateIndicatorChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editIndicatorChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.editIndicatorChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$body = ; // UpdateIndicatorChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editIndicatorChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->editIndicatorChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateIndicatorChartConfigEntry->new(); # UpdateIndicatorChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editIndicatorChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->editIndicatorChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
body =  # UpdateIndicatorChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_indicator_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->editIndicatorChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getIndicatorChart

Get a chart by Id


/service/charts/indicator/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/indicator/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getIndicatorChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#getIndicatorChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getIndicatorChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#getIndicatorChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getIndicatorChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIndicatorChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIndicatorChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getIndicatorChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.getIndicatorChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getIndicatorChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->getIndicatorChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getIndicatorChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->getIndicatorChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_indicator_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->getIndicatorChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getIndicatorChartConfig

Get the configuration informations of an existing chart


/service/charts/indicator/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/indicator/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IndicatorChartControllerApi;

import java.io.File;
import java.util.*;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            IndicatorChartConfig result = apiInstance.getIndicatorChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#getIndicatorChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IndicatorChartControllerApi;

public class IndicatorChartControllerApiExample {

    public static void main(String[] args) {
        IndicatorChartControllerApi apiInstance = new IndicatorChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            IndicatorChartConfig result = apiInstance.getIndicatorChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndicatorChartControllerApi#getIndicatorChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

IndicatorChartControllerApi *apiInstance = [[IndicatorChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getIndicatorChartConfigWith:id
    project:project
              completionHandler: ^(IndicatorChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.IndicatorChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIndicatorChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIndicatorChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new IndicatorChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                IndicatorChartConfig result = apiInstance.getIndicatorChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IndicatorChartControllerApi.getIndicatorChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiIndicatorChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getIndicatorChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndicatorChartControllerApi->getIndicatorChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IndicatorChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::IndicatorChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getIndicatorChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndicatorChartControllerApi->getIndicatorChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.IndicatorChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_indicator_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndicatorChartControllerApi->getIndicatorChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


JobTypeController

findAllUsingGET1

findAll


/service/job_types

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/job_types?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobTypeControllerApi;

import java.io.File;
import java.util.*;

public class JobTypeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JobTypeControllerApi apiInstance = new JobTypeControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[JobType] result = apiInstance.findAllUsingGET1(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobTypeControllerApi#findAllUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobTypeControllerApi;

public class JobTypeControllerApiExample {

    public static void main(String[] args) {
        JobTypeControllerApi apiInstance = new JobTypeControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[JobType] result = apiInstance.findAllUsingGET1(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobTypeControllerApi#findAllUsingGET1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

JobTypeControllerApi *apiInstance = [[JobTypeControllerApi alloc] init];

// findAll
[apiInstance findAllUsingGET1With:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[JobType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JobTypeControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllUsingGET1(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllUsingGET1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobTypeControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // findAll
                array[JobType] result = apiInstance.findAllUsingGET1(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobTypeControllerApi.findAllUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJobTypeControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->findAllUsingGET1($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobTypeControllerApi->findAllUsingGET1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobTypeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JobTypeControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->findAllUsingGET1(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobTypeControllerApi->findAllUsingGET1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JobTypeControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # findAll
    api_response = api_instance.find_all_using_get1(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobTypeControllerApi->findAllUsingGET1: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


JsonDepotController

createJsonDepot

create Json Depot


/service/depots/json

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        JsonDepot body = ; // JsonDepot | jsonDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            JsonDepot result = apiInstance.createJsonDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        JsonDepot body = ; // JsonDepot | jsonDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            JsonDepot result = apiInstance.createJsonDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
JsonDepot *body = ; // jsonDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// create Json Depot
[apiInstance createJsonDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(JsonDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{JsonDepot}} jsonDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJsonDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJsonDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new JsonDepot(); // JsonDepot | jsonDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Json Depot
                JsonDepot result = apiInstance.createJsonDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.createJsonDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // JsonDepot | jsonDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createJsonDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->createJsonDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::JsonDepot->new(); # JsonDepot | jsonDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createJsonDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->createJsonDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # JsonDepot | jsonDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Json Depot
    api_response = api_instance.create_json_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->createJsonDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createJsonDepotHeader

create Depot Header


/service/depots/json/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createJsonDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createJsonDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createJsonDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJsonDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJsonDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createJsonDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.createJsonDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createJsonDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->createJsonDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createJsonDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->createJsonDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_json_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->createJsonDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createJsonExtraction

create Extraction


/service/depots/json/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createJsonExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createJsonExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// create Extraction
[apiInstance createJsonExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createJsonExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJsonExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createJsonExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.createJsonExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createJsonExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->createJsonExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createJsonExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->createJsonExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_json_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->createJsonExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createJsonExtractionFilter

create Extraction Filter


/service/depots/json/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createJsonExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createJsonExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#createJsonExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createJsonExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJsonExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJsonExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createJsonExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.createJsonExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createJsonExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->createJsonExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createJsonExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->createJsonExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_json_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->createJsonExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllJsonDepotHeader

delete All Depot Header


/service/depots/json/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/json/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllJsonDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteAllJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllJsonDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteAllJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllJsonDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllJsonDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllJsonDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllJsonDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.deleteAllJsonDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllJsonDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->deleteAllJsonDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllJsonDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->deleteAllJsonDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_json_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->deleteAllJsonDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteJsonDepot

delete Json Depot


/service/depots/json/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/json/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteJsonDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteJsonDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// delete Json Depot
[apiInstance deleteJsonDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJsonDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJsonDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Json Depot
                apiInstance.deleteJsonDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.deleteJsonDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteJsonDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->deleteJsonDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteJsonDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->deleteJsonDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # delete Json Depot
    api_instance.delete_json_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->deleteJsonDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteJsonDepotFileByName

delete json file by name


/service/depots/json/{depotId}/remote_files

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/json/{depotId}/remote_files?ctx=&fileName=&isTemp=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteJsonDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonDepotFileByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteJsonDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonDepotFileByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Boolean *isTemp = true; // isTemp
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// delete json file by name
[apiInstance deleteJsonDepotFileByNameWith:ctx
    depotId:depotId
    fileName:fileName
    isTemp:isTemp
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var isTemp = true; // {{Boolean}} isTemp
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJsonDepotFileByName(ctx, depotId, fileName, isTemp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJsonDepotFileByNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var isTemp = true;  // Boolean | isTemp
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete json file by name
                apiInstance.deleteJsonDepotFileByName(ctx, depotId, fileName, isTemp, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.deleteJsonDepotFileByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$isTemp = true; // Boolean | isTemp
$project = 789; // Long | Project id

try {
    $api_instance->deleteJsonDepotFileByName($ctx, $depotId, $fileName, $isTemp, $project);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->deleteJsonDepotFileByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $isTemp = true; # Boolean | isTemp
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteJsonDepotFileByName(ctx => $ctx, depotId => $depotId, fileName => $fileName, isTemp => $isTemp, project => $project);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->deleteJsonDepotFileByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
isTemp = true # Boolean | isTemp
project = 789 # Long | Project id (optional)

try: 
    # delete json file by name
    api_instance.delete_json_depot_file_by_name(ctx, depotId, fileName, isTemp, project=project)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->deleteJsonDepotFileByName: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
isTemp*
Boolean
isTemp
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteJsonDepotHeader

delete Depot Header


/service/depots/json/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteJsonDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteJsonDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteJsonDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteJsonDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJsonDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteJsonDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.deleteJsonDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteJsonDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->deleteJsonDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteJsonDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->deleteJsonDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_json_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->deleteJsonDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteJsonExtraction

delete Extraction


/service/depots/json/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/json/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteJsonExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteJsonExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteJsonExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJsonExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJsonExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteJsonExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.deleteJsonExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteJsonExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->deleteJsonExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteJsonExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->deleteJsonExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_json_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->deleteJsonExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteJsonExtractionFilter

delete Extraction Filter


/service/depots/json/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteJsonExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteJsonExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#deleteJsonExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteJsonExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteJsonExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJsonExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteJsonExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.deleteJsonExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteJsonExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->deleteJsonExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteJsonExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->deleteJsonExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_json_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->deleteJsonExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


detectJsonCharset

Detect json depot charset

This operation is applied on a random file from the depots files


/service/depots/json/{depotId}/charset

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/depots/json/{depotId}/charset?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.detectJsonCharset(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#detectJsonCharset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.detectJsonCharset(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#detectJsonCharset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Detect json depot charset
[apiInstance detectJsonCharsetWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.detectJsonCharset(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class detectJsonCharsetExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Detect json depot charset
                'String' result = apiInstance.detectJsonCharset(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.detectJsonCharset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->detectJsonCharset($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->detectJsonCharset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->detectJsonCharset(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->detectJsonCharset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Detect json depot charset
    api_response = api_instance.detect_json_charset(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->detectJsonCharset: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


downloadLocalJsonFile

Download local JSON file


/service/depot/json/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depot/json/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalJsonFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#downloadLocalJsonFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalJsonFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#downloadLocalJsonFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Download local JSON file
[apiInstance downloadLocalJsonFileWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadLocalJsonFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadLocalJsonFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download local JSON file
                apiInstance.downloadLocalJsonFile(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.downloadLocalJsonFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadLocalJsonFile($token);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->downloadLocalJsonFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadLocalJsonFile(token => $token);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->downloadLocalJsonFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download local JSON file
    api_instance.download_local_json_file(token=token)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->downloadLocalJsonFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editJsonDepot

edit Json Depot


/service/depots/json/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        JsonDepot body = ; // JsonDepot | jsonDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            JsonDepot result = apiInstance.editJsonDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#editJsonDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        JsonDepot body = ; // JsonDepot | jsonDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            JsonDepot result = apiInstance.editJsonDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#editJsonDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
JsonDepot *body = ; // jsonDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// edit Json Depot
[apiInstance editJsonDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(JsonDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{JsonDepot}} jsonDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editJsonDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editJsonDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new JsonDepot(); // JsonDepot | jsonDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Json Depot
                JsonDepot result = apiInstance.editJsonDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.editJsonDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // JsonDepot | jsonDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editJsonDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->editJsonDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::JsonDepot->new(); # JsonDepot | jsonDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editJsonDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->editJsonDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # JsonDepot | jsonDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # edit Json Depot
    api_response = api_instance.edit_json_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->editJsonDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editJsonDepotHeader

edit Depot Header


/service/depots/json/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editJsonDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#editJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editJsonDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#editJsonDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editJsonDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editJsonDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editJsonDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editJsonDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.editJsonDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editJsonDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->editJsonDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editJsonDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->editJsonDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_json_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->editJsonDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editJsonExtractionFilter

edit Extraction Filter


/service/depots/json/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editJsonExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#editJsonExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editJsonExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#editJsonExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editJsonExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editJsonExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editJsonExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editJsonExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.editJsonExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editJsonExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->editJsonExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editJsonExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->editJsonExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_json_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->editJsonExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllJsonDepot

find All JsonDepot


/service/depots/json

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[JsonDepot] result = apiInstance.findAllJsonDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#findAllJsonDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[JsonDepot] result = apiInstance.findAllJsonDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#findAllJsonDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// find All JsonDepot
[apiInstance findAllJsonDepotWith:project
              completionHandler: ^(array[JsonDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllJsonDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllJsonDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All JsonDepot
                array[JsonDepot] result = apiInstance.findAllJsonDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.findAllJsonDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllJsonDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->findAllJsonDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllJsonDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->findAllJsonDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # find All JsonDepot
    api_response = api_instance.find_all_json_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->findAllJsonDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllJsonExtractionFilters

find All Extraction Filters


/service/depots/json/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllJsonExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#findAllJsonExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllJsonExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#findAllJsonExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllJsonExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllJsonExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllJsonExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllJsonExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.findAllJsonExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllJsonExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->findAllJsonExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllJsonExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->findAllJsonExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_json_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->findAllJsonExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneJsonDepotById

find One Json Depot By Id


/service/depots/json/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            JsonDepot result = apiInstance.findOneJsonDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#findOneJsonDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            JsonDepot result = apiInstance.findOneJsonDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#findOneJsonDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// find One Json Depot By Id
[apiInstance findOneJsonDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(JsonDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneJsonDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneJsonDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // find One Json Depot By Id
                JsonDepot result = apiInstance.findOneJsonDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.findOneJsonDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneJsonDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->findOneJsonDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneJsonDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->findOneJsonDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # find One Json Depot By Id
    api_response = api_instance.find_one_json_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->findOneJsonDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersFromJsonDepot

Get headers from a json depot


/service/depots/json/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/headers?ctx=&inferSchema=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        JsonDepot body = ; // JsonDepot | jsonDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromJsonDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getHeadersFromJsonDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        JsonDepot body = ; // JsonDepot | jsonDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromJsonDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getHeadersFromJsonDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
JsonDepot *body = ; // jsonDepot
Integer *ctx = 56; // ctx
Boolean *inferSchema = true; // inferSchema (optional)
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Get headers from a json depot
[apiInstance getHeadersFromJsonDepotWith:body
    ctx:ctx
    inferSchema:inferSchema
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{JsonDepot}} jsonDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'inferSchema': true // {{Boolean}} inferSchema
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersFromJsonDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersFromJsonDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new JsonDepot(); // JsonDepot | jsonDepot
            var ctx = 56;  // Integer | ctx
            var inferSchema = true;  // Boolean | inferSchema (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a json depot
                array[array[Object]] result = apiInstance.getHeadersFromJsonDepot(body, ctx, inferSchema, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getHeadersFromJsonDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // JsonDepot | jsonDepot
$ctx = 56; // Integer | ctx
$inferSchema = true; // Boolean | inferSchema
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHeadersFromJsonDepot($body, $ctx, $inferSchema, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getHeadersFromJsonDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::JsonDepot->new(); # JsonDepot | jsonDepot
my $ctx = 56; # Integer | ctx
my $inferSchema = true; # Boolean | inferSchema
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHeadersFromJsonDepot(body => $body, ctx => $ctx, inferSchema => $inferSchema, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getHeadersFromJsonDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # JsonDepot | jsonDepot
ctx = 56 # Integer | ctx
inferSchema = true # Boolean | inferSchema (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a json depot
    api_response = api_instance.get_headers_from_json_depot(body, ctx, inferSchema=inferSchema, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getHeadersFromJsonDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
inferSchema
Boolean
inferSchema
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonDepotExtractions

get Json Extractions


/service/depots/json/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getJsonDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getJsonDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// get Json Extractions
[apiInstance getJsonDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Json Extractions
                array['String'] result = apiInstance.getJsonDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getJsonDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getJsonDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Json Extractions
    api_response = api_instance.get_json_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonDepotFilesCount

get Depot Files Count


/service/depots/json/{depotId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/count?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getJsonDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotFilesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getJsonDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotFilesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// get Depot Files Count
[apiInstance getJsonDepotFilesCountWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonDepotFilesCount(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonDepotFilesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Files Count
                Long result = apiInstance.getJsonDepotFilesCount(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonDepotFilesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getJsonDepotFilesCount($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonDepotFilesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getJsonDepotFilesCount(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonDepotFilesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Files Count
    api_response = api_instance.get_json_depot_files_count(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonDepotFilesCount: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonDepotHeadersByDepotId

get Depot Headers By DepotId


/service/depots/json/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getJsonDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getJsonDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// get Depot Headers By DepotId
[apiInstance getJsonDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By DepotId
                array[DepotHeader] result = apiInstance.getJsonDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getJsonDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getJsonDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By DepotId
    api_response = api_instance.get_json_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonDepotRemoteFiles

Get json depot remoteFiles


/service/depots/json/{depotId}/remote_files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/remote_files?ctx=&filenameMask=&includeTemp=&limit=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getJsonDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getJsonDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *filenameMask = filenameMask_example; // filenameMask
Boolean *includeTemp = true; // includeTemp
Integer *limit = 56; // limit
Long *project = 789; // Project id (optional)
String *remotePath = remotePath_example; // remotePath (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Get json depot remoteFiles
[apiInstance getJsonDepotRemoteFilesWith:ctx
    depotId:depotId
    filenameMask:filenameMask
    includeTemp:includeTemp
    limit:limit
    project:project
    remotePath:remotePath
              completionHandler: ^(array[RemoteFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var filenameMask = filenameMask_example; // {{String}} filenameMask
var includeTemp = true; // {{Boolean}} includeTemp
var limit = 56; // {{Integer}} limit
var opts = { 
  'project': 789, // {{Long}} Project id
  'remotePath': remotePath_example // {{String}} remotePath
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonDepotRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var filenameMask = filenameMask_example;  // String | filenameMask
            var includeTemp = true;  // Boolean | includeTemp
            var limit = 56;  // Integer | limit
            var project = 789;  // Long | Project id (optional) 
            var remotePath = remotePath_example;  // String | remotePath (optional) 

            try
            {
                // Get json depot remoteFiles
                array[RemoteFile] result = apiInstance.getJsonDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonDepotRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$filenameMask = filenameMask_example; // String | filenameMask
$includeTemp = true; // Boolean | includeTemp
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$remotePath = remotePath_example; // String | remotePath

try {
    $result = $api_instance->getJsonDepotRemoteFiles($ctx, $depotId, $filenameMask, $includeTemp, $limit, $project, $remotePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonDepotRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $filenameMask = filenameMask_example; # String | filenameMask
my $includeTemp = true; # Boolean | includeTemp
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $remotePath = remotePath_example; # String | remotePath

eval { 
    my $result = $api_instance->getJsonDepotRemoteFiles(ctx => $ctx, depotId => $depotId, filenameMask => $filenameMask, includeTemp => $includeTemp, limit => $limit, project => $project, remotePath => $remotePath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonDepotRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
filenameMask = filenameMask_example # String | filenameMask
includeTemp = true # Boolean | includeTemp
limit = 56 # Integer | limit
project = 789 # Long | Project id (optional)
remotePath = remotePath_example # String | remotePath (optional)

try: 
    # Get json depot remoteFiles
    api_response = api_instance.get_json_depot_remote_files(ctx, depotId, filenameMask, includeTemp, limit, project=project, remotePath=remotePath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonDepotRemoteFiles: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filenameMask*
String
filenameMask
Required
includeTemp*
Boolean
includeTemp
Required
limit*
Integer (int32)
limit
Required
project
Long (int64)
Project id
remotePath
String
remotePath

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonExtractionFilePreview

get Extraction FilePreview


/service/depots/json/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getJsonExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getJsonExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// get Extraction FilePreview
[apiInstance getJsonExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction FilePreview
                DepotData result = apiInstance.getJsonExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getJsonExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getJsonExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction FilePreview
    api_response = api_instance.get_json_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonFileDownloadToken

Get download token for a local JSON file


/service/depot/json/{depotId}/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/depot/json/{depotId}/file/token?fileName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getJsonFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonFileDownloadToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getJsonFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonFileDownloadToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Get download token for a  local JSON file
[apiInstance getJsonFileDownloadTokenWith:depotId
    fileName:fileName
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonFileDownloadToken(depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonFileDownloadTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get download token for a  local JSON file
                'String' result = apiInstance.getJsonFileDownloadToken(depotId, fileName, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonFileDownloadToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id

try {
    $result = $api_instance->getJsonFileDownloadToken($depotId, $fileName, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonFileDownloadToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getJsonFileDownloadToken(depotId => $depotId, fileName => $fileName, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonFileDownloadToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)

try: 
    # Get download token for a  local JSON file
    api_response = api_instance.get_json_file_download_token(depotId, fileName, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonFileDownloadToken: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
fileName*
String
fileName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getJsonPreviewDepot

Get JSON depot preview


/service/depots/json/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getJsonPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getJsonPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#getJsonPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Get JSON depot preview
[apiInstance getJsonPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get JSON depot preview
                DepotData result = apiInstance.getJsonPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.getJsonPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getJsonPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->getJsonPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getJsonPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->getJsonPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get JSON depot preview
    api_response = api_instance.get_json_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->getJsonPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleJsonFileUpload

Upload Binary file to a depot


/service/depots/json/upload_file

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/upload_file?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleJsonFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#handleJsonFileUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleJsonFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#handleJsonFileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Upload Binary file to a depot
[apiInstance handleJsonFileUploadWith:ctx
    project:project
              completionHandler: ^(FileUpload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleJsonFileUpload(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleJsonFileUploadExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Upload Binary file to a depot
                FileUpload result = apiInstance.handleJsonFileUpload(ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.handleJsonFileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleJsonFileUpload($ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->handleJsonFileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleJsonFileUpload(ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->handleJsonFileUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Upload Binary file to a depot
    api_response = api_instance.handle_json_file_upload(ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->handleJsonFileUpload: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveJsonDepotTempFolderOnTypeUpdate

move temp folder when type is changed


/service/depots/json/move_tmp_folder_on_type_update

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/json/move_tmp_folder_on_type_update?ctx=&depotCode=&newDepotType=&oldDepotType=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveJsonDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#moveJsonDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveJsonDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#moveJsonDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *depotCode = depotCode_example; // depotCode
String *newDepotType = newDepotType_example; // newDepotType
String *oldDepotType = oldDepotType_example; // oldDepotType
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// move temp folder when type is changed
[apiInstance moveJsonDepotTempFolderOnTypeUpdateWith:ctx
    depotCode:depotCode
    newDepotType:newDepotType
    oldDepotType:oldDepotType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotCode = depotCode_example; // {{String}} depotCode
var newDepotType = newDepotType_example; // {{String}} newDepotType
var oldDepotType = oldDepotType_example; // {{String}} oldDepotType
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveJsonDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveJsonDepotTempFolderOnTypeUpdateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotCode = depotCode_example;  // String | depotCode
            var newDepotType = newDepotType_example;  // String | newDepotType
            var oldDepotType = oldDepotType_example;  // String | oldDepotType
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // move temp folder when type is changed
                apiInstance.moveJsonDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.moveJsonDepotTempFolderOnTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotCode = depotCode_example; // String | depotCode
$newDepotType = newDepotType_example; // String | newDepotType
$oldDepotType = oldDepotType_example; // String | oldDepotType
$project = 789; // Long | Project id

try {
    $api_instance->moveJsonDepotTempFolderOnTypeUpdate($ctx, $depotCode, $newDepotType, $oldDepotType, $project);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->moveJsonDepotTempFolderOnTypeUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotCode = depotCode_example; # String | depotCode
my $newDepotType = newDepotType_example; # String | newDepotType
my $oldDepotType = oldDepotType_example; # String | oldDepotType
my $project = 789; # Long | Project id

eval { 
    $api_instance->moveJsonDepotTempFolderOnTypeUpdate(ctx => $ctx, depotCode => $depotCode, newDepotType => $newDepotType, oldDepotType => $oldDepotType, project => $project);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->moveJsonDepotTempFolderOnTypeUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotCode = depotCode_example # String | depotCode
newDepotType = newDepotType_example # String | newDepotType
oldDepotType = oldDepotType_example # String | oldDepotType
project = 789 # Long | Project id (optional)

try: 
    # move temp folder when type is changed
    api_instance.move_json_depot_temp_folder_on_type_update(ctx, depotCode, newDepotType, oldDepotType, project=project)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->moveJsonDepotTempFolderOnTypeUpdate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotCode*
String
depotCode
Required
newDepotType*
String
newDepotType
Required
oldDepotType*
String
oldDepotType
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


previewRemoteJsonFile

Get json depot file preview


/service/depots/json/{depotId}/remote_files/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/json/{depotId}/remote_files/preview?ctx=&fileName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteJsonFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#previewRemoteJsonFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteJsonFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#previewRemoteJsonFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// Get json depot file preview
[apiInstance previewRemoteJsonFileWith:ctx
    depotId:depotId
    fileName:fileName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewRemoteJsonFile(ctx, depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewRemoteJsonFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Get json depot file preview
                DepotData result = apiInstance.previewRemoteJsonFile(ctx, depotId, fileName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.previewRemoteJsonFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->previewRemoteJsonFile($ctx, $depotId, $fileName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->previewRemoteJsonFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->previewRemoteJsonFile(ctx => $ctx, depotId => $depotId, fileName => $fileName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->previewRemoteJsonFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Get json depot file preview
    api_response = api_instance.preview_remote_json_file(ctx, depotId, fileName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->previewRemoteJsonFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateJsonDepotActivationStatus

update Depot Activation Status


/service/depots/json/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/json/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateJsonDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#updateJsonDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateJsonDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#updateJsonDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateJsonDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateJsonDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateJsonDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateJsonDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.updateJsonDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateJsonDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->updateJsonDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateJsonDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->updateJsonDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_json_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->updateJsonDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateJsonDepotHeadersPositions

update Depot Headers Positions


/service/depots/json/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/json/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonDepotControllerApi;

import java.io.File;
import java.util.*;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateJsonDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#updateJsonDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JsonDepotControllerApi;

public class JsonDepotControllerApiExample {

    public static void main(String[] args) {
        JsonDepotControllerApi apiInstance = new JsonDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateJsonDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonDepotControllerApi#updateJsonDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

JsonDepotControllerApi *apiInstance = [[JsonDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateJsonDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.JsonDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateJsonDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateJsonDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JsonDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateJsonDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonDepotControllerApi.updateJsonDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiJsonDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateJsonDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling JsonDepotControllerApi->updateJsonDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::JsonDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateJsonDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling JsonDepotControllerApi->updateJsonDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.JsonDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_json_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling JsonDepotControllerApi->updateJsonDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


LanguageController

getAllUsingGET1

getAll


/service/langues

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/langues"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LanguageControllerApi;

import java.io.File;
import java.util.*;

public class LanguageControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        LanguageControllerApi apiInstance = new LanguageControllerApi();
        try {
            array[Language] result = apiInstance.getAllUsingGET1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LanguageControllerApi#getAllUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LanguageControllerApi;

public class LanguageControllerApiExample {

    public static void main(String[] args) {
        LanguageControllerApi apiInstance = new LanguageControllerApi();
        try {
            array[Language] result = apiInstance.getAllUsingGET1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LanguageControllerApi#getAllUsingGET1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

LanguageControllerApi *apiInstance = [[LanguageControllerApi alloc] init];

// getAll
[apiInstance getAllUsingGET1WithCompletionHandler: 
              ^(array[Language] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.LanguageControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllUsingGET1(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllUsingGET1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LanguageControllerApi();

            try
            {
                // getAll
                array[Language] result = apiInstance.getAllUsingGET1();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LanguageControllerApi.getAllUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiLanguageControllerApi();

try {
    $result = $api_instance->getAllUsingGET1();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LanguageControllerApi->getAllUsingGET1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LanguageControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::LanguageControllerApi->new();

eval { 
    my $result = $api_instance->getAllUsingGET1();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LanguageControllerApi->getAllUsingGET1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.LanguageControllerApi()

try: 
    # getAll
    api_response = api_instance.get_all_using_get1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LanguageControllerApi->getAllUsingGET1: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getErrorUsingGET

getError


/service/langues/error_

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/langues/error_"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LanguageControllerApi;

import java.io.File;
import java.util.*;

public class LanguageControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        LanguageControllerApi apiInstance = new LanguageControllerApi();
        try {
            Error result = apiInstance.getErrorUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LanguageControllerApi#getErrorUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LanguageControllerApi;

public class LanguageControllerApiExample {

    public static void main(String[] args) {
        LanguageControllerApi apiInstance = new LanguageControllerApi();
        try {
            Error result = apiInstance.getErrorUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LanguageControllerApi#getErrorUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

LanguageControllerApi *apiInstance = [[LanguageControllerApi alloc] init];

// getError
[apiInstance getErrorUsingGETWithCompletionHandler: 
              ^(Error output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.LanguageControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getErrorUsingGET(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getErrorUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LanguageControllerApi();

            try
            {
                // getError
                Error result = apiInstance.getErrorUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LanguageControllerApi.getErrorUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiLanguageControllerApi();

try {
    $result = $api_instance->getErrorUsingGET();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LanguageControllerApi->getErrorUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LanguageControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::LanguageControllerApi->new();

eval { 
    my $result = $api_instance->getErrorUsingGET();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LanguageControllerApi->getErrorUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.LanguageControllerApi()

try: 
    # getError
    api_response = api_instance.get_error_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LanguageControllerApi->getErrorUsingGET: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


MapController

checkConfigUsingGET7

Check the configuration informations of an existing map


/service/maps/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/maps/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | HdMap Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET7(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#checkConfigUsingGET7");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | HdMap Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET7(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#checkConfigUsingGET7");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdMap Id
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Check the configuration informations of an existing map
[apiInstance checkConfigUsingGET7With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var id = 789; // {{Long}} HdMap Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET7(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET7Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var id = 789;  // Long | HdMap Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing map
                'Boolean' result = apiInstance.checkConfigUsingGET7(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.checkConfigUsingGET7: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$id = 789; // Long | HdMap Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET7($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->checkConfigUsingGET7: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $id = 789; # Long | HdMap Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET7(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->checkConfigUsingGET7: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
id = 789 # Long | HdMap Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing map
    api_response = api_instance.check_config_using_get7(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->checkConfigUsingGET7: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMap Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createMap

Create a new map

Create a new map and returns the new generated Id


/service/maps

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/maps?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        CreateMapEntry body = ; // CreateMapEntry | New map data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createMap(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#createMap");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        CreateMapEntry body = ; // CreateMapEntry | New map data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createMap(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#createMap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateMapEntry *body = ; // New map data
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Create a new map
[apiInstance createMapWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var body = ; // {{CreateMapEntry}} New map data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMap(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMapExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var body = new CreateMapEntry(); // CreateMapEntry | New map data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new map
                Long result = apiInstance.createMap(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.createMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$body = ; // CreateMapEntry | New map data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createMap($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->createMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateMapEntry->new(); # CreateMapEntry | New map data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createMap(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->createMap: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
body =  # CreateMapEntry | New map data
project = 789 # Long | Project id (optional)

try: 
    # Create a new map
    api_response = api_instance.create_map(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->createMap: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createMapFromDb

Create a new map from datablock

Create a new map from datablock and returns the new generated Id


/service/maps/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/maps/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long body = ; // Long | Datablock Id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createMapFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#createMapFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long body = ; // Long | Datablock Id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createMapFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#createMapFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *body = ; // Datablock Id
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Create a new map from datablock
[apiInstance createMapFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var body = ; // {{Long}} Datablock Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMapFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMapFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var body = new Long(); // Long | Datablock Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new map from datablock
                Long result = apiInstance.createMapFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.createMapFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$body = ; // Long | Datablock Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->createMapFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->createMapFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | Datablock Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createMapFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->createMapFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
body =  # Long | Datablock Id
project = 789 # Long | Project id (optional)

try: 
    # Create a new map from datablock
    api_response = api_instance.create_map_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->createMapFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteManyMaps

Delete a list of maps


/service/maps

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/maps?mapsId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        array[Long] mapsId = ; // array[Long] | Requested maps Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyMaps(mapsId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#deleteManyMaps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        array[Long] mapsId = ; // array[Long] | Requested maps Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyMaps(mapsId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#deleteManyMaps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *mapsId = ; // Requested maps Ids
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Delete a list of maps
[apiInstance deleteManyMapsWith:mapsId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var mapsId = ; // {{array[Long]}} Requested maps Ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteManyMaps(mapsId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteManyMapsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var mapsId = new array[Long](); // array[Long] | Requested maps Ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of maps
                apiInstance.deleteManyMaps(mapsId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.deleteManyMaps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$mapsId = ; // array[Long] | Requested maps Ids
$project = 789; // Long | Project id

try {
    $api_instance->deleteManyMaps($mapsId, $project);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->deleteManyMaps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $mapsId = []; # array[Long] | Requested maps Ids
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteManyMaps(mapsId => $mapsId, project => $project);
};
if ($@) {
    warn "Exception when calling MapControllerApi->deleteManyMaps: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
mapsId =  # array[Long] | Requested maps Ids
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of maps
    api_instance.delete_many_maps(mapsId, project=project)
except ApiException as e:
    print("Exception when calling MapControllerApi->deleteManyMaps: %s\n" % e)

Parameters

Query parameters
Name Description
mapsId*
array[Long] (int64)
Requested maps Ids
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteMap

Delete an existing map


/service/maps/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/maps/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | The Id of the map to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMap(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#deleteMap");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | The Id of the map to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMap(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#deleteMap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the map to be deleted
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Delete an existing map
[apiInstance deleteMapWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var id = 789; // {{Long}} The Id of the map to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMap(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMapExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var id = 789;  // Long | The Id of the map to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing map
                apiInstance.deleteMap(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.deleteMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$id = 789; // Long | The Id of the map to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteMap($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->deleteMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $id = 789; # Long | The Id of the map to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteMap(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling MapControllerApi->deleteMap: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
id = 789 # Long | The Id of the map to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing map
    api_instance.delete_map(id, project=project)
except ApiException as e:
    print("Exception when calling MapControllerApi->deleteMap: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the map to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateMap

Duplicate an existing map


/service/maps/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/maps/{id}/duplicate?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | The Id of the map to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateMap(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#duplicateMap");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | The Id of the map to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateMap(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#duplicateMap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the map to be duplicated
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Duplicate an existing map
[apiInstance duplicateMapWith:id
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var id = 789; // {{Long}} The Id of the map to be duplicated
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateMap(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateMapExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var id = 789;  // Long | The Id of the map to be duplicated
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Duplicate an existing map
                Long result = apiInstance.duplicateMap(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.duplicateMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$id = 789; // Long | The Id of the map to be duplicated
$project = 789; // Long | Project id

try {
    $result = $api_instance->duplicateMap($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->duplicateMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $id = 789; # Long | The Id of the map to be duplicated
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->duplicateMap(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->duplicateMap: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
id = 789 # Long | The Id of the map to be duplicated
project = 789 # Long | Project id (optional)

try: 
    # Duplicate an existing map
    api_response = api_instance.duplicate_map(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->duplicateMap: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the map to be duplicated
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editMap

Edit map

Edit an existing map


/service/maps/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/maps/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        UpdateMapEntry body = ; // UpdateMapEntry | Update map data
        Long id = 789; // Long | Id of map to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editMap(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#editMap");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        UpdateMapEntry body = ; // UpdateMapEntry | Update map data
        Long id = 789; // Long | Id of map to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editMap(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#editMap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateMapEntry *body = ; // Update map data
Long *id = 789; // Id of map to update data
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Edit map
[apiInstance editMapWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var body = ; // {{UpdateMapEntry}} Update map data
var id = 789; // {{Long}} Id of map to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editMap(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editMapExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var body = new UpdateMapEntry(); // UpdateMapEntry | Update map data
            var id = 789;  // Long | Id of map to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit map
                apiInstance.editMap(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.editMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$body = ; // UpdateMapEntry | Update map data
$id = 789; // Long | Id of map to update data
$project = 789; // Long | Project id

try {
    $api_instance->editMap($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->editMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateMapEntry->new(); # UpdateMapEntry | Update map data
my $id = 789; # Long | Id of map to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editMap(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling MapControllerApi->editMap: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
body =  # UpdateMapEntry | Update map data
id = 789 # Long | Id of map to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit map
    api_instance.edit_map(body, id, project=project)
except ApiException as e:
    print("Exception when calling MapControllerApi->editMap: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of map to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editMapConfig

Update the configuration informations of an existing map


/service/maps/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/maps/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        UpdateMapConfigEntry body = ; // UpdateMapConfigEntry | The update configuration data
        Long id = 789; // Long | HdMap Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editMapConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#editMapConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        UpdateMapConfigEntry body = ; // UpdateMapConfigEntry | The update configuration data
        Long id = 789; // Long | HdMap Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editMapConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#editMapConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateMapConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdMap Id
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Update the configuration informations of an existing map
[apiInstance editMapConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var body = ; // {{UpdateMapConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdMap Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editMapConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editMapConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var body = new UpdateMapConfigEntry(); // UpdateMapConfigEntry | The update configuration data
            var id = 789;  // Long | HdMap Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing map
                apiInstance.editMapConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.editMapConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$body = ; // UpdateMapConfigEntry | The update configuration data
$id = 789; // Long | HdMap Id
$project = 789; // Long | Project id

try {
    $api_instance->editMapConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->editMapConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateMapConfigEntry->new(); # UpdateMapConfigEntry | The update configuration data
my $id = 789; # Long | HdMap Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editMapConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling MapControllerApi->editMapConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
body =  # UpdateMapConfigEntry | The update configuration data
id = 789 # Long | HdMap Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing map
    api_instance.edit_map_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling MapControllerApi->editMapConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMap Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getAllMaps

Get a list of the available maps


/service/maps

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/maps?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdMap] result = apiInstance.getAllMaps(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getAllMaps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdMap] result = apiInstance.getAllMaps(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getAllMaps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Get a list of the available maps
[apiInstance getAllMapsWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[HdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllMaps(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllMapsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of the available maps
                array[HdMap] result = apiInstance.getAllMaps(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.getAllMaps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllMaps($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->getAllMaps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllMaps(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->getAllMaps: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of the available maps
    api_response = api_instance.get_all_maps(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->getAllMaps: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMap

Get a map by Id


/service/maps/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/maps/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | Requested map Id
        Long project = 789; // Long | Project id
        try {
            HdMap result = apiInstance.getMap(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getMap");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | Requested map Id
        Long project = 789; // Long | Project id
        try {
            HdMap result = apiInstance.getMap(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getMap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested map Id
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Get a map by Id
[apiInstance getMapWith:id
    project:project
              completionHandler: ^(HdMap output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var id = 789; // {{Long}} Requested map Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMap(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMapExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var id = 789;  // Long | Requested map Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a map by Id
                HdMap result = apiInstance.getMap(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.getMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$id = 789; // Long | Requested map Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMap($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->getMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $id = 789; # Long | Requested map Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMap(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->getMap: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
id = 789 # Long | Requested map Id
project = 789 # Long | Project id (optional)

try: 
    # Get a map by Id
    api_response = api_instance.get_map(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->getMap: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested map Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMapConfig

Get the configuration informations of an existing map


/service/maps/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/maps/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | HdMap Id
        Long project = 789; // Long | Project id
        try {
            MapConfig result = apiInstance.getMapConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getMapConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long id = 789; // Long | HdMap Id
        Long project = 789; // Long | Project id
        try {
            MapConfig result = apiInstance.getMapConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getMapConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdMap Id
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Get the configuration informations of an existing map
[apiInstance getMapConfigWith:id
    project:project
              completionHandler: ^(MapConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var id = 789; // {{Long}} HdMap Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMapConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMapConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var id = 789;  // Long | HdMap Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing map
                MapConfig result = apiInstance.getMapConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.getMapConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$id = 789; // Long | HdMap Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMapConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->getMapConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $id = 789; # Long | HdMap Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMapConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->getMapConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
id = 789 # Long | HdMap Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing map
    api_response = api_instance.get_map_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->getMapConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMap Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMapElementsForMove

Get maps linked element for move/copy


/service/maps/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/maps/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Map ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getMapElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getMapElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Map ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getMapElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#getMapElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Map ID (optional)
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Get maps linked element for move/copy
[apiInstance getMapElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Map ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMapElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMapElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Map ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get maps linked element for move/copy
                array[DcUsedElement] result = apiInstance.getMapElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.getMapElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Map ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMapElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->getMapElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Map ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMapElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->getMapElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Map ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get maps linked element for move/copy
    api_response = api_instance.get_map_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->getMapElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Map ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveMapElements

Move Map and linked elements to another project


/service/maps/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/maps/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MapControllerApi;

import java.io.File;
import java.util.*;

public class MapControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MapControllerApi apiInstance = new MapControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Map ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveMapElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#moveMapElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MapControllerApi;

public class MapControllerApiExample {

    public static void main(String[] args) {
        MapControllerApi apiInstance = new MapControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | Map ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveMapElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapControllerApi#moveMapElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // Map ID (optional)
Long *project = 789; // Project id (optional)

MapControllerApi *apiInstance = [[MapControllerApi alloc] init];

// Move Map and linked elements to another project
[apiInstance moveMapElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MapControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} Map ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveMapElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveMapElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MapControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | Map ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move Map and linked elements to another project
                DcMoveResponse result = apiInstance.moveMapElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MapControllerApi.moveMapElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMapControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | Map ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveMapElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MapControllerApi->moveMapElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MapControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MapControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | Map ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveMapElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapControllerApi->moveMapElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MapControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | Map ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move Map and linked elements to another project
    api_response = api_instance.move_map_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapControllerApi->moveMapElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
Map ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


MongodbDepotController

createMongodbDepot

Create a Database Mongodb depot by id


/service/depots/mongodb

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            MongodbDepot result = apiInstance.createMongodbDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            MongodbDepot result = apiInstance.createMongodbDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MongodbDepot *body = ; // mongodbDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Create a Database Mongodb depot by id
[apiInstance createMongodbDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(MongodbDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{MongodbDepot}} mongodbDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMongodbDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMongodbDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new MongodbDepot(); // MongodbDepot | mongodbDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Create a Database Mongodb depot by id
                MongodbDepot result = apiInstance.createMongodbDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.createMongodbDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // MongodbDepot | mongodbDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createMongodbDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->createMongodbDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::MongodbDepot->new(); # MongodbDepot | mongodbDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createMongodbDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->createMongodbDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # MongodbDepot | mongodbDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Create a Database Mongodb depot by id
    api_response = api_instance.create_mongodb_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->createMongodbDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createMongodbDepotHeader

create Depot Header


/service/depots/mongodb/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createMongodbDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createMongodbDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createMongodbDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMongodbDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMongodbDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createMongodbDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.createMongodbDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createMongodbDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->createMongodbDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createMongodbDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->createMongodbDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_mongodb_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->createMongodbDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createMongodbExtraction

create Extraction


/service/depots/mongodb/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createMongodbExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createMongodbExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// create Extraction
[apiInstance createMongodbExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createMongodbExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMongodbExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createMongodbExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.createMongodbExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createMongodbExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->createMongodbExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createMongodbExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->createMongodbExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_mongodb_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->createMongodbExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createMongodbExtractionFilter

create Extraction Filter


/service/depots/mongodb/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createMongodbExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createMongodbExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#createMongodbExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createMongodbExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMongodbExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMongodbExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createMongodbExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.createMongodbExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createMongodbExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->createMongodbExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createMongodbExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->createMongodbExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_mongodb_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->createMongodbExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllMongodbDepotHeader

delete All Depot Header


/service/depots/mongodb/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/mongodb/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllMongodbDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteAllMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllMongodbDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteAllMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllMongodbDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllMongodbDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllMongodbDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllMongodbDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.deleteAllMongodbDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllMongodbDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->deleteAllMongodbDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllMongodbDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->deleteAllMongodbDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_mongodb_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->deleteAllMongodbDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteMongodbDepot

Delete a Database Mongodb depot


/service/depots/mongodb/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/mongodb/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMongodbDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMongodbDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Delete a Database Mongodb depot
[apiInstance deleteMongodbDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMongodbDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMongodbDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a Database Mongodb depot
                apiInstance.deleteMongodbDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.deleteMongodbDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteMongodbDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->deleteMongodbDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteMongodbDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->deleteMongodbDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Delete a Database Mongodb depot
    api_instance.delete_mongodb_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->deleteMongodbDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteMongodbDepotHeader

delete Depot Header


/service/depots/mongodb/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteMongodbDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteMongodbDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteMongodbDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteMongodbDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMongodbDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteMongodbDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.deleteMongodbDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteMongodbDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->deleteMongodbDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteMongodbDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->deleteMongodbDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_mongodb_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->deleteMongodbDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteMongodbExtraction

delete Extraction


/service/depots/mongodb/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/mongodb/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMongodbExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteMongodbExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteMongodbExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMongodbExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMongodbExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteMongodbExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.deleteMongodbExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteMongodbExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->deleteMongodbExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteMongodbExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->deleteMongodbExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_mongodb_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->deleteMongodbExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteMongodbExtractionFilter

delete Extraction Filter


/service/depots/mongodb/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteMongodbExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteMongodbExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#deleteMongodbExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteMongodbExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteMongodbExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteMongodbExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteMongodbExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.deleteMongodbExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteMongodbExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->deleteMongodbExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteMongodbExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->deleteMongodbExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_mongodb_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->deleteMongodbExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editMongodbDepot

Edit a Database Mongodb depot


/service/depots/mongodb/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            MongodbDepot result = apiInstance.editMongodbDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#editMongodbDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            MongodbDepot result = apiInstance.editMongodbDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#editMongodbDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MongodbDepot *body = ; // mongodbDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Edit a Database Mongodb depot
[apiInstance editMongodbDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(MongodbDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{MongodbDepot}} mongodbDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editMongodbDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editMongodbDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new MongodbDepot(); // MongodbDepot | mongodbDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a Database Mongodb depot
                MongodbDepot result = apiInstance.editMongodbDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.editMongodbDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // MongodbDepot | mongodbDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editMongodbDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->editMongodbDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::MongodbDepot->new(); # MongodbDepot | mongodbDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editMongodbDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->editMongodbDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # MongodbDepot | mongodbDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Edit a Database Mongodb depot
    api_response = api_instance.edit_mongodb_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->editMongodbDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editMongodbDepotHeader

edit Depot Header


/service/depots/mongodb/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editMongodbDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#editMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editMongodbDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#editMongodbDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editMongodbDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editMongodbDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editMongodbDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editMongodbDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.editMongodbDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editMongodbDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->editMongodbDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editMongodbDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->editMongodbDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_mongodb_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->editMongodbDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editMongodbExtractionFilter

edit Extraction Filter


/service/depots/mongodb/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editMongodbExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#editMongodbExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editMongodbExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#editMongodbExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editMongodbExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editMongodbExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editMongodbExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editMongodbExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.editMongodbExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editMongodbExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->editMongodbExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editMongodbExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->editMongodbExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_mongodb_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->editMongodbExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllMongodbDepot

View a list of Database MongoDB depots


/service/depots/mongodb

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[MongodbDepot] result = apiInstance.findAllMongodbDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#findAllMongodbDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[MongodbDepot] result = apiInstance.findAllMongodbDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#findAllMongodbDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// View a list of Database MongoDB depots
[apiInstance findAllMongodbDepotWith:project
              completionHandler: ^(array[MongodbDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllMongodbDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllMongodbDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of Database MongoDB depots
                array[MongodbDepot] result = apiInstance.findAllMongodbDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.findAllMongodbDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllMongodbDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->findAllMongodbDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllMongodbDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->findAllMongodbDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of Database MongoDB depots
    api_response = api_instance.find_all_mongodb_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->findAllMongodbDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllMongodbExtractionFilters

find All Extraction Filters


/service/depots/mongodb/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllMongodbExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#findAllMongodbExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllMongodbExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#findAllMongodbExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllMongodbExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllMongodbExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllMongodbExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllMongodbExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.findAllMongodbExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllMongodbExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->findAllMongodbExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllMongodbExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->findAllMongodbExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_mongodb_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->findAllMongodbExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneMongodbDepotById

Get a Database MongoDB depot by id


/service/depots/mongodb/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            MongodbDepot result = apiInstance.findOneMongodbDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#findOneMongodbDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            MongodbDepot result = apiInstance.findOneMongodbDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#findOneMongodbDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Get a Database MongoDB depot by id
[apiInstance findOneMongodbDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(MongodbDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneMongodbDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneMongodbDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // Get a Database MongoDB depot by id
                MongodbDepot result = apiInstance.findOneMongodbDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.findOneMongodbDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneMongodbDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->findOneMongodbDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneMongodbDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->findOneMongodbDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # Get a Database MongoDB depot by id
    api_response = api_instance.find_one_mongodb_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->findOneMongodbDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongoDbPreviewDepot

Get MongoDb depot preview


/service/depots/mongodb/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getMongoDbPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongoDbPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getMongoDbPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongoDbPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Get MongoDb depot preview
[apiInstance getMongoDbPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongoDbPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongoDbPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get MongoDb depot preview
                DepotData result = apiInstance.getMongoDbPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.getMongoDbPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMongoDbPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->getMongoDbPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMongoDbPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->getMongoDbPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get MongoDb depot preview
    api_response = api_instance.get_mongo_db_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->getMongoDbPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongodbDepotExtractions

get Depot Extractions


/service/depots/mongodb/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getMongodbDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getMongodbDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getMongodbDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongodbDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongodbDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getMongodbDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.getMongodbDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMongodbDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->getMongodbDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMongodbDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->getMongodbDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_mongodb_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->getMongodbDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongodbDepotHeadersByDepotId

get Depot Headers By DepotId


/service/depots/mongodb/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getMongodbDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getMongodbDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// get Depot Headers By DepotId
[apiInstance getMongodbDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongodbDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongodbDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By DepotId
                array[DepotHeader] result = apiInstance.getMongodbDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.getMongodbDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMongodbDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->getMongodbDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMongodbDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->getMongodbDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By DepotId
    api_response = api_instance.get_mongodb_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->getMongodbDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongodbExtractionFilePreview

get Extraction File Preview


/service/depots/mongodb/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/mongodb/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getMongodbExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getMongodbExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getMongodbExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongodbExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongodbExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getMongodbExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.getMongodbExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getMongodbExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->getMongodbExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getMongodbExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->getMongodbExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_mongodb_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->getMongodbExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongodbHeadersFromDepot

Get headers from a Database Mongodb depot


/service/depots/mongodb/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/headers?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getMongodbHeadersFromDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbHeadersFromDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getMongodbHeadersFromDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbHeadersFromDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MongodbDepot *body = ; // mongodbDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Get headers from a Database Mongodb depot
[apiInstance getMongodbHeadersFromDepotWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{MongodbDepot}} mongodbDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongodbHeadersFromDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongodbHeadersFromDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new MongodbDepot(); // MongodbDepot | mongodbDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a Database Mongodb depot
                array[array[Object]] result = apiInstance.getMongodbHeadersFromDepot(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.getMongodbHeadersFromDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // MongodbDepot | mongodbDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getMongodbHeadersFromDepot($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->getMongodbHeadersFromDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::MongodbDepot->new(); # MongodbDepot | mongodbDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getMongodbHeadersFromDepot(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->getMongodbHeadersFromDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # MongodbDepot | mongodbDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a Database Mongodb depot
    api_response = api_instance.get_mongodb_headers_from_depot(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->getMongodbHeadersFromDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMongodbPreview

Get a preview from a Database Mongodb depot


/service/depots/mongodb/preview

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/preview?ctx=&project=&useCache=&withData="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        Boolean withData = true; // Boolean | withData
        try {
            DepotData result = apiInstance.getMongodbPreview(body, ctx, project, useCache, withData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbPreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        MongodbDepot body = ; // MongodbDepot | mongodbDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        Boolean withData = true; // Boolean | withData
        try {
            DepotData result = apiInstance.getMongodbPreview(body, ctx, project, useCache, withData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#getMongodbPreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MongodbDepot *body = ; // mongodbDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)
Boolean *withData = true; // withData (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// Get a preview from a Database Mongodb depot
[apiInstance getMongodbPreviewWith:body
    ctx:ctx
    project:project
    useCache:useCache
    withData:withData
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{MongodbDepot}} mongodbDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
  'withData': true // {{Boolean}} withData
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMongodbPreview(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMongodbPreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new MongodbDepot(); // MongodbDepot | mongodbDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 
            var withData = true;  // Boolean | withData (optional) 

            try
            {
                // Get a preview from a Database Mongodb depot
                DepotData result = apiInstance.getMongodbPreview(body, ctx, project, useCache, withData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.getMongodbPreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // MongodbDepot | mongodbDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache
$withData = true; // Boolean | withData

try {
    $result = $api_instance->getMongodbPreview($body, $ctx, $project, $useCache, $withData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->getMongodbPreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::MongodbDepot->new(); # MongodbDepot | mongodbDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache
my $withData = true; # Boolean | withData

eval { 
    my $result = $api_instance->getMongodbPreview(body => $body, ctx => $ctx, project => $project, useCache => $useCache, withData => $withData);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->getMongodbPreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # MongodbDepot | mongodbDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)
withData = true # Boolean | withData (optional)

try: 
    # Get a preview from a Database Mongodb depot
    api_response = api_instance.get_mongodb_preview(body, ctx, project=project, useCache=useCache, withData=withData)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->getMongodbPreview: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
useCache
Boolean
useCache
withData
Boolean
withData

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateMongodbDepotActivationStatus

update Depot Activation Status


/service/depots/mongodb/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/mongodb/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateMongodbDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#updateMongodbDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateMongodbDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#updateMongodbDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateMongodbDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateMongodbDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMongodbDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateMongodbDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.updateMongodbDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateMongodbDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->updateMongodbDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateMongodbDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->updateMongodbDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_mongodb_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->updateMongodbDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateMongodbDepotHeadersPositions

update Depot Headers Positions


/service/depots/mongodb/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/mongodb/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MongodbDepotControllerApi;

import java.io.File;
import java.util.*;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateMongodbDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#updateMongodbDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MongodbDepotControllerApi;

public class MongodbDepotControllerApiExample {

    public static void main(String[] args) {
        MongodbDepotControllerApi apiInstance = new MongodbDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateMongodbDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling MongodbDepotControllerApi#updateMongodbDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

MongodbDepotControllerApi *apiInstance = [[MongodbDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateMongodbDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MongodbDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateMongodbDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMongodbDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MongodbDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateMongodbDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MongodbDepotControllerApi.updateMongodbDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMongodbDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateMongodbDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling MongodbDepotControllerApi->updateMongodbDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MongodbDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MongodbDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateMongodbDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling MongodbDepotControllerApi->updateMongodbDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MongodbDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_mongodb_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling MongodbDepotControllerApi->updateMongodbDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


MonitoringController

freeSparkDiskUsingDELETE

freeSparkDisk


/service/monitoring/context/free_disk/{ctx}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/monitoring/context/free_disk/{ctx}?clearExportedData="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MonitoringControllerApi;

import java.io.File;
import java.util.*;

public class MonitoringControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MonitoringControllerApi apiInstance = new MonitoringControllerApi();
        Boolean clearExportedData = true; // Boolean | clearExportedData
        Integer ctx = 56; // Integer | ctx
        try {
            array['String'] result = apiInstance.freeSparkDiskUsingDELETE(clearExportedData, ctx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MonitoringControllerApi#freeSparkDiskUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MonitoringControllerApi;

public class MonitoringControllerApiExample {

    public static void main(String[] args) {
        MonitoringControllerApi apiInstance = new MonitoringControllerApi();
        Boolean clearExportedData = true; // Boolean | clearExportedData
        Integer ctx = 56; // Integer | ctx
        try {
            array['String'] result = apiInstance.freeSparkDiskUsingDELETE(clearExportedData, ctx);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MonitoringControllerApi#freeSparkDiskUsingDELETE");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *clearExportedData = true; // clearExportedData
Integer *ctx = 56; // ctx

MonitoringControllerApi *apiInstance = [[MonitoringControllerApi alloc] init];

// freeSparkDisk
[apiInstance freeSparkDiskUsingDELETEWith:clearExportedData
    ctx:ctx
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MonitoringControllerApi()
var clearExportedData = true; // {{Boolean}} clearExportedData
var ctx = 56; // {{Integer}} ctx

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.freeSparkDiskUsingDELETE(clearExportedData, ctx, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class freeSparkDiskUsingDELETEExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MonitoringControllerApi();
            var clearExportedData = true;  // Boolean | clearExportedData
            var ctx = 56;  // Integer | ctx

            try
            {
                // freeSparkDisk
                array['String'] result = apiInstance.freeSparkDiskUsingDELETE(clearExportedData, ctx);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MonitoringControllerApi.freeSparkDiskUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMonitoringControllerApi();
$clearExportedData = true; // Boolean | clearExportedData
$ctx = 56; // Integer | ctx

try {
    $result = $api_instance->freeSparkDiskUsingDELETE($clearExportedData, $ctx);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MonitoringControllerApi->freeSparkDiskUsingDELETE: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MonitoringControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MonitoringControllerApi->new();
my $clearExportedData = true; # Boolean | clearExportedData
my $ctx = 56; # Integer | ctx

eval { 
    my $result = $api_instance->freeSparkDiskUsingDELETE(clearExportedData => $clearExportedData, ctx => $ctx);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MonitoringControllerApi->freeSparkDiskUsingDELETE: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MonitoringControllerApi()
clearExportedData = true # Boolean | clearExportedData
ctx = 56 # Integer | ctx

try: 
    # freeSparkDisk
    api_response = api_instance.free_spark_disk_using_delete(clearExportedData, ctx)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MonitoringControllerApi->freeSparkDiskUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
ctx*
Integer (int32)
ctx
Required
Query parameters
Name Description
clearExportedData*
Boolean
clearExportedData
Required

Responses

Status: 200 - OK


getSparkContextFSMetrics

Get FS metrics information of spark context instance


/service/monitoring/context/file_system/{ctx}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/monitoring/context/file_system/{ctx}?level="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MonitoringControllerApi;

import java.io.File;
import java.util.*;

public class MonitoringControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MonitoringControllerApi apiInstance = new MonitoringControllerApi();
        Integer ctx = 56; // Integer | ctx
        Integer level = 56; // Integer | level
        try {
            array[FsMemoryUsage] result = apiInstance.getSparkContextFSMetrics(ctx, level);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MonitoringControllerApi#getSparkContextFSMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MonitoringControllerApi;

public class MonitoringControllerApiExample {

    public static void main(String[] args) {
        MonitoringControllerApi apiInstance = new MonitoringControllerApi();
        Integer ctx = 56; // Integer | ctx
        Integer level = 56; // Integer | level
        try {
            array[FsMemoryUsage] result = apiInstance.getSparkContextFSMetrics(ctx, level);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MonitoringControllerApi#getSparkContextFSMetrics");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Integer *level = 56; // level

MonitoringControllerApi *apiInstance = [[MonitoringControllerApi alloc] init];

// Get FS metrics information of spark context instance
[apiInstance getSparkContextFSMetricsWith:ctx
    level:level
              completionHandler: ^(array[FsMemoryUsage] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.MonitoringControllerApi()
var ctx = 56; // {{Integer}} ctx
var level = 56; // {{Integer}} level

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSparkContextFSMetrics(ctx, level, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSparkContextFSMetricsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MonitoringControllerApi();
            var ctx = 56;  // Integer | ctx
            var level = 56;  // Integer | level

            try
            {
                // Get FS metrics information of spark context instance
                array[FsMemoryUsage] result = apiInstance.getSparkContextFSMetrics(ctx, level);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MonitoringControllerApi.getSparkContextFSMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMonitoringControllerApi();
$ctx = 56; // Integer | ctx
$level = 56; // Integer | level

try {
    $result = $api_instance->getSparkContextFSMetrics($ctx, $level);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MonitoringControllerApi->getSparkContextFSMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MonitoringControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MonitoringControllerApi->new();
my $ctx = 56; # Integer | ctx
my $level = 56; # Integer | level

eval { 
    my $result = $api_instance->getSparkContextFSMetrics(ctx => $ctx, level => $level);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MonitoringControllerApi->getSparkContextFSMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MonitoringControllerApi()
ctx = 56 # Integer | ctx
level = 56 # Integer | level

try: 
    # Get FS metrics information of spark context instance
    api_response = api_instance.get_spark_context_fs_metrics(ctx, level)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MonitoringControllerApi->getSparkContextFSMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
ctx*
Integer (int32)
ctx
Required
Query parameters
Name Description
level*
Integer (int32)
level
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


Neo4jDepotController

createNeo4jDepot

Create a Database Neo4j depot by id


/service/depots/neo4j

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Neo4jDepot result = apiInstance.createNeo4jDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Neo4jDepot result = apiInstance.createNeo4jDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Neo4jDepot *body = ; // neo4jDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// Create a Database Neo4j depot by id
[apiInstance createNeo4jDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Neo4jDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{Neo4jDepot}} neo4jDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNeo4jDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNeo4jDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new Neo4jDepot(); // Neo4jDepot | neo4jDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Create a Database Neo4j depot by id
                Neo4jDepot result = apiInstance.createNeo4jDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.createNeo4jDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // Neo4jDepot | neo4jDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createNeo4jDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->createNeo4jDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::Neo4jDepot->new(); # Neo4jDepot | neo4jDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createNeo4jDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->createNeo4jDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # Neo4jDepot | neo4jDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Create a Database Neo4j depot by id
    api_response = api_instance.create_neo4j_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->createNeo4jDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createNeo4jDepotHeader

create Depot Header


/service/depots/neo4j/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createNeo4jDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createNeo4jDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createNeo4jDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNeo4jDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNeo4jDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createNeo4jDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.createNeo4jDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createNeo4jDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->createNeo4jDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createNeo4jDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->createNeo4jDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_neo4j_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->createNeo4jDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createNeo4jExtraction

create Extraction


/service/depots/neo4j/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createNeo4jExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createNeo4jExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// create Extraction
[apiInstance createNeo4jExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createNeo4jExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNeo4jExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createNeo4jExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.createNeo4jExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createNeo4jExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->createNeo4jExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createNeo4jExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->createNeo4jExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_neo4j_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->createNeo4jExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createNeo4jExtractionFilter

create Extraction Filter


/service/depots/neo4j/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createNeo4jExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createNeo4jExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#createNeo4jExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createNeo4jExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNeo4jExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNeo4jExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createNeo4jExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.createNeo4jExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createNeo4jExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->createNeo4jExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createNeo4jExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->createNeo4jExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_neo4j_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->createNeo4jExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllNeo4jDepotHeader

delete All Depot Header


/service/depots/neo4j/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/neo4j/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllNeo4jDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteAllNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllNeo4jDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteAllNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllNeo4jDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllNeo4jDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllNeo4jDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllNeo4jDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.deleteAllNeo4jDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllNeo4jDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->deleteAllNeo4jDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllNeo4jDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->deleteAllNeo4jDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_neo4j_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->deleteAllNeo4jDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteNeo4jDepot

Delete a Database Neo4j depot


/service/depots/neo4j/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/neo4j/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteNeo4jDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteNeo4jDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// Delete a Database Neo4j depot
[apiInstance deleteNeo4jDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteNeo4jDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNeo4jDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a Database Neo4j depot
                apiInstance.deleteNeo4jDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.deleteNeo4jDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteNeo4jDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->deleteNeo4jDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteNeo4jDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->deleteNeo4jDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Delete a Database Neo4j depot
    api_instance.delete_neo4j_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->deleteNeo4jDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteNeo4jDepotHeader

delete Depot Header


/service/depots/neo4j/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteNeo4jDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteNeo4jDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteNeo4jDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteNeo4jDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNeo4jDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteNeo4jDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.deleteNeo4jDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteNeo4jDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->deleteNeo4jDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteNeo4jDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->deleteNeo4jDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_neo4j_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->deleteNeo4jDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteNeo4jExtraction

delete Extraction


/service/depots/neo4j/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/neo4j/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteNeo4jExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteNeo4jExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteNeo4jExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteNeo4jExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNeo4jExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteNeo4jExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.deleteNeo4jExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteNeo4jExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->deleteNeo4jExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteNeo4jExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->deleteNeo4jExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_neo4j_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->deleteNeo4jExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteNeo4jExtractionFilter

delete Extraction Filter


/service/depots/neo4j/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteNeo4jExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteNeo4jExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#deleteNeo4jExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteNeo4jExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteNeo4jExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNeo4jExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteNeo4jExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.deleteNeo4jExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteNeo4jExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->deleteNeo4jExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteNeo4jExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->deleteNeo4jExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_neo4j_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->deleteNeo4jExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editNeo4jDepot

Edit a Database Neo4j depot


/service/depots/neo4j/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Neo4jDepot result = apiInstance.editNeo4jDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#editNeo4jDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Neo4jDepot result = apiInstance.editNeo4jDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#editNeo4jDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Neo4jDepot *body = ; // neo4jDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// Edit a Database Neo4j depot
[apiInstance editNeo4jDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Neo4jDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{Neo4jDepot}} neo4jDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editNeo4jDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editNeo4jDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new Neo4jDepot(); // Neo4jDepot | neo4jDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a Database Neo4j depot
                Neo4jDepot result = apiInstance.editNeo4jDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.editNeo4jDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // Neo4jDepot | neo4jDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editNeo4jDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->editNeo4jDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::Neo4jDepot->new(); # Neo4jDepot | neo4jDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editNeo4jDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->editNeo4jDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # Neo4jDepot | neo4jDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Edit a Database Neo4j depot
    api_response = api_instance.edit_neo4j_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->editNeo4jDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editNeo4jDepotHeader

edit Depot Header


/service/depots/neo4j/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editNeo4jDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#editNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editNeo4jDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#editNeo4jDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editNeo4jDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editNeo4jDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editNeo4jDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editNeo4jDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.editNeo4jDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editNeo4jDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->editNeo4jDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editNeo4jDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->editNeo4jDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_neo4j_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->editNeo4jDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editNeo4jExtractionFilter

edit Extraction Filter


/service/depots/neo4j/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editNeo4jExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#editNeo4jExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editNeo4jExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#editNeo4jExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editNeo4jExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editNeo4jExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editNeo4jExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editNeo4jExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.editNeo4jExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editNeo4jExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->editNeo4jExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editNeo4jExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->editNeo4jExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_neo4j_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->editNeo4jExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllNeo4jDepot

View a list of Database Neo4j depots


/service/depots/neo4j

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[Neo4jDepot] result = apiInstance.findAllNeo4jDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#findAllNeo4jDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[Neo4jDepot] result = apiInstance.findAllNeo4jDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#findAllNeo4jDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// View a list of Database Neo4j depots
[apiInstance findAllNeo4jDepotWith:project
              completionHandler: ^(array[Neo4jDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllNeo4jDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllNeo4jDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of Database Neo4j depots
                array[Neo4jDepot] result = apiInstance.findAllNeo4jDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.findAllNeo4jDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllNeo4jDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->findAllNeo4jDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllNeo4jDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->findAllNeo4jDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of Database Neo4j depots
    api_response = api_instance.find_all_neo4j_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->findAllNeo4jDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllNeo4jExtractionFilters

find All Extraction Filters


/service/depots/neo4j/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllNeo4jExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#findAllNeo4jExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllNeo4jExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#findAllNeo4jExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllNeo4jExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllNeo4jExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllNeo4jExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllNeo4jExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.findAllNeo4jExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllNeo4jExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->findAllNeo4jExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllNeo4jExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->findAllNeo4jExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_neo4j_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->findAllNeo4jExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneNeo4jDepotById

Get a Database MongoDB depot by id


/service/depots/neo4j/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            Neo4jDepot result = apiInstance.findOneNeo4jDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#findOneNeo4jDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            Neo4jDepot result = apiInstance.findOneNeo4jDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#findOneNeo4jDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// Get a Database MongoDB depot by id
[apiInstance findOneNeo4jDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(Neo4jDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneNeo4jDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneNeo4jDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // Get a Database MongoDB depot by id
                Neo4jDepot result = apiInstance.findOneNeo4jDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.findOneNeo4jDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneNeo4jDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->findOneNeo4jDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneNeo4jDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->findOneNeo4jDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # Get a Database MongoDB depot by id
    api_response = api_instance.find_one_neo4j_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->findOneNeo4jDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getNeo4jDepotExtractions

get Depot Extractions


/service/depots/neo4j/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getNeo4jDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getNeo4jDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getNeo4jDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNeo4jDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNeo4jDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getNeo4jDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.getNeo4jDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getNeo4jDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->getNeo4jDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getNeo4jDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->getNeo4jDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_neo4j_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->getNeo4jDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getNeo4jDepotHeadersByDepotId

get Depot Headers By DepotId


/service/depots/neo4j/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getNeo4jDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getNeo4jDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// get Depot Headers By DepotId
[apiInstance getNeo4jDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNeo4jDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNeo4jDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By DepotId
                array[DepotHeader] result = apiInstance.getNeo4jDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.getNeo4jDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getNeo4jDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->getNeo4jDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getNeo4jDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->getNeo4jDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By DepotId
    api_response = api_instance.get_neo4j_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->getNeo4jDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getNeo4jExtractionFilePreview

get Extraction File Preview


/service/depots/neo4j/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/neo4j/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getNeo4jExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getNeo4jExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getNeo4jExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNeo4jExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNeo4jExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getNeo4jExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.getNeo4jExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getNeo4jExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->getNeo4jExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getNeo4jExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->getNeo4jExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_neo4j_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->getNeo4jExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getNeo4jHeadersFromDepot

Get headers from a Database Neo4j depot


/service/depots/neo4j/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/headers?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getNeo4jHeadersFromDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jHeadersFromDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getNeo4jHeadersFromDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jHeadersFromDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Neo4jDepot *body = ; // neo4jDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// Get headers from a Database Neo4j depot
[apiInstance getNeo4jHeadersFromDepotWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{Neo4jDepot}} neo4jDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNeo4jHeadersFromDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNeo4jHeadersFromDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new Neo4jDepot(); // Neo4jDepot | neo4jDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a Database Neo4j depot
                array[array[Object]] result = apiInstance.getNeo4jHeadersFromDepot(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.getNeo4jHeadersFromDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // Neo4jDepot | neo4jDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getNeo4jHeadersFromDepot($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->getNeo4jHeadersFromDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::Neo4jDepot->new(); # Neo4jDepot | neo4jDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getNeo4jHeadersFromDepot(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->getNeo4jHeadersFromDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # Neo4jDepot | neo4jDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a Database Neo4j depot
    api_response = api_instance.get_neo4j_headers_from_depot(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->getNeo4jHeadersFromDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getNeo4jPreview

Get a preview from a Database Neo4j depot


/service/depots/neo4j/preview

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/preview?ctx=&project=&useCache=&withData="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        Boolean withData = true; // Boolean | withData
        try {
            DepotData result = apiInstance.getNeo4jPreview(body, ctx, project, useCache, withData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jPreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Neo4jDepot body = ; // Neo4jDepot | neo4jDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        Boolean withData = true; // Boolean | withData
        try {
            DepotData result = apiInstance.getNeo4jPreview(body, ctx, project, useCache, withData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#getNeo4jPreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Neo4jDepot *body = ; // neo4jDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)
Boolean *withData = true; // withData (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// Get a preview from a Database Neo4j depot
[apiInstance getNeo4jPreviewWith:body
    ctx:ctx
    project:project
    useCache:useCache
    withData:withData
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{Neo4jDepot}} neo4jDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
  'withData': true // {{Boolean}} withData
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNeo4jPreview(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNeo4jPreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new Neo4jDepot(); // Neo4jDepot | neo4jDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 
            var withData = true;  // Boolean | withData (optional) 

            try
            {
                // Get a preview from a Database Neo4j depot
                DepotData result = apiInstance.getNeo4jPreview(body, ctx, project, useCache, withData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.getNeo4jPreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // Neo4jDepot | neo4jDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache
$withData = true; // Boolean | withData

try {
    $result = $api_instance->getNeo4jPreview($body, $ctx, $project, $useCache, $withData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->getNeo4jPreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::Neo4jDepot->new(); # Neo4jDepot | neo4jDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache
my $withData = true; # Boolean | withData

eval { 
    my $result = $api_instance->getNeo4jPreview(body => $body, ctx => $ctx, project => $project, useCache => $useCache, withData => $withData);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->getNeo4jPreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # Neo4jDepot | neo4jDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)
withData = true # Boolean | withData (optional)

try: 
    # Get a preview from a Database Neo4j depot
    api_response = api_instance.get_neo4j_preview(body, ctx, project=project, useCache=useCache, withData=withData)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->getNeo4jPreview: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
useCache
Boolean
useCache
withData
Boolean
withData

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateNeo4jDepotActivationStatus

update Depot Activation Status


/service/depots/neo4j/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/neo4j/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateNeo4jDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#updateNeo4jDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateNeo4jDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#updateNeo4jDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateNeo4jDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateNeo4jDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateNeo4jDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateNeo4jDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.updateNeo4jDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateNeo4jDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->updateNeo4jDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateNeo4jDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->updateNeo4jDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_neo4j_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->updateNeo4jDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateNeo4jDepotHeadersPositions

update Depot Headers Positions


/service/depots/neo4j/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/neo4j/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Neo4jDepotControllerApi;

import java.io.File;
import java.util.*;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateNeo4jDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#updateNeo4jDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Neo4jDepotControllerApi;

public class Neo4jDepotControllerApiExample {

    public static void main(String[] args) {
        Neo4jDepotControllerApi apiInstance = new Neo4jDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateNeo4jDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling Neo4jDepotControllerApi#updateNeo4jDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

Neo4jDepotControllerApi *apiInstance = [[Neo4jDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateNeo4jDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.Neo4jDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateNeo4jDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateNeo4jDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new Neo4jDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateNeo4jDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Neo4jDepotControllerApi.updateNeo4jDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNeo4jDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateNeo4jDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling Neo4jDepotControllerApi->updateNeo4jDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Neo4jDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::Neo4jDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateNeo4jDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling Neo4jDepotControllerApi->updateNeo4jDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.Neo4jDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_neo4j_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling Neo4jDepotControllerApi->updateNeo4jDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


ParquetDepotController

createParquetDepot

create Parquet Depot


/service/depots/parquet

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ParquetDepot body = ; // ParquetDepot | parquetDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            ParquetDepot result = apiInstance.createParquetDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ParquetDepot body = ; // ParquetDepot | parquetDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            ParquetDepot result = apiInstance.createParquetDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ParquetDepot *body = ; // parquetDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// create Parquet Depot
[apiInstance createParquetDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(ParquetDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{ParquetDepot}} parquetDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createParquetDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createParquetDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new ParquetDepot(); // ParquetDepot | parquetDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Parquet Depot
                ParquetDepot result = apiInstance.createParquetDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.createParquetDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // ParquetDepot | parquetDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createParquetDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->createParquetDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ParquetDepot->new(); # ParquetDepot | parquetDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createParquetDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->createParquetDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # ParquetDepot | parquetDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Parquet Depot
    api_response = api_instance.create_parquet_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->createParquetDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createParquetDepotHeader

create Depot Header


/service/depots/parquet/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createParquetDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createParquetDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createParquetDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createParquetDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createParquetDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createParquetDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.createParquetDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createParquetDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->createParquetDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createParquetDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->createParquetDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_parquet_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->createParquetDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createParquetExtraction

Create depot Extraction


/service/depots/parquet/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createParquetExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createParquetExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Create depot Extraction
[apiInstance createParquetExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createParquetExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createParquetExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create depot Extraction
                apiInstance.createParquetExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.createParquetExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createParquetExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->createParquetExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createParquetExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->createParquetExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # Create depot Extraction
    api_instance.create_parquet_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->createParquetExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createParquetExtractionFilter

create Extraction Filter


/service/depots/parquet/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createParquetExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createParquetExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#createParquetExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createParquetExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createParquetExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createParquetExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createParquetExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.createParquetExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createParquetExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->createParquetExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createParquetExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->createParquetExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_parquet_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->createParquetExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllParquetDepotHeader

delete All Depot Header


/service/depots/parquet/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/parquet/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllParquetDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteAllParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllParquetDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteAllParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllParquetDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllParquetDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllParquetDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllParquetDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.deleteAllParquetDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllParquetDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->deleteAllParquetDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllParquetDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->deleteAllParquetDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_parquet_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->deleteAllParquetDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteParquetDepot

delete Parquet Depot


/service/depots/parquet/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/parquet/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteParquetDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteParquetDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// delete Parquet Depot
[apiInstance deleteParquetDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteParquetDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteParquetDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Parquet Depot
                apiInstance.deleteParquetDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.deleteParquetDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteParquetDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->deleteParquetDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteParquetDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->deleteParquetDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # delete Parquet Depot
    api_instance.delete_parquet_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->deleteParquetDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteParquetDepotFileByName

delete parquet file by name


/service/depots/parquet/{depotId}/remote_files

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/parquet/{depotId}/remote_files?ctx=&fileName=&isTemp=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteParquetDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetDepotFileByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteParquetDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetDepotFileByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Boolean *isTemp = true; // isTemp
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// delete parquet file by name
[apiInstance deleteParquetDepotFileByNameWith:ctx
    depotId:depotId
    fileName:fileName
    isTemp:isTemp
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var isTemp = true; // {{Boolean}} isTemp
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteParquetDepotFileByName(ctx, depotId, fileName, isTemp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteParquetDepotFileByNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var isTemp = true;  // Boolean | isTemp
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete parquet file by name
                apiInstance.deleteParquetDepotFileByName(ctx, depotId, fileName, isTemp, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.deleteParquetDepotFileByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$isTemp = true; // Boolean | isTemp
$project = 789; // Long | Project id

try {
    $api_instance->deleteParquetDepotFileByName($ctx, $depotId, $fileName, $isTemp, $project);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->deleteParquetDepotFileByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $isTemp = true; # Boolean | isTemp
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteParquetDepotFileByName(ctx => $ctx, depotId => $depotId, fileName => $fileName, isTemp => $isTemp, project => $project);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->deleteParquetDepotFileByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
isTemp = true # Boolean | isTemp
project = 789 # Long | Project id (optional)

try: 
    # delete parquet file by name
    api_instance.delete_parquet_depot_file_by_name(ctx, depotId, fileName, isTemp, project=project)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->deleteParquetDepotFileByName: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
isTemp*
Boolean
isTemp
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteParquetDepotHeader

delete Depot Header


/service/depots/parquet/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteParquetDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteParquetDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteParquetDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteParquetDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteParquetDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteParquetDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.deleteParquetDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteParquetDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->deleteParquetDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteParquetDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->deleteParquetDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_parquet_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->deleteParquetDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteParquetExtraction

delete Extraction


/service/depots/parquet/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/parquet/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteParquetExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteParquetExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteParquetExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteParquetExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteParquetExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteParquetExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.deleteParquetExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteParquetExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->deleteParquetExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteParquetExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->deleteParquetExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_parquet_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->deleteParquetExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteParquetExtractionFilter

delete Extraction Filter


/service/depots/parquet/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteParquetExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteParquetExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#deleteParquetExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteParquetExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteParquetExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteParquetExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteParquetExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.deleteParquetExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteParquetExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->deleteParquetExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteParquetExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->deleteParquetExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_parquet_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->deleteParquetExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


downloadLocalParquetFile

Download local PARQUET file


/service/depot/parquet/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depot/parquet/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalParquetFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#downloadLocalParquetFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalParquetFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#downloadLocalParquetFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Download local PARQUET file
[apiInstance downloadLocalParquetFileWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadLocalParquetFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadLocalParquetFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download local PARQUET file
                apiInstance.downloadLocalParquetFile(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.downloadLocalParquetFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadLocalParquetFile($token);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->downloadLocalParquetFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadLocalParquetFile(token => $token);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->downloadLocalParquetFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download local PARQUET file
    api_instance.download_local_parquet_file(token=token)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->downloadLocalParquetFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editParquetDepot

edit Parquet Depot


/service/depots/parquet/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ParquetDepot body = ; // ParquetDepot | parquetDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ParquetDepot result = apiInstance.editParquetDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#editParquetDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ParquetDepot body = ; // ParquetDepot | parquetDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ParquetDepot result = apiInstance.editParquetDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#editParquetDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ParquetDepot *body = ; // parquetDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// edit Parquet Depot
[apiInstance editParquetDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(ParquetDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{ParquetDepot}} parquetDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editParquetDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editParquetDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new ParquetDepot(); // ParquetDepot | parquetDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Parquet Depot
                ParquetDepot result = apiInstance.editParquetDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.editParquetDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // ParquetDepot | parquetDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editParquetDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->editParquetDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ParquetDepot->new(); # ParquetDepot | parquetDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editParquetDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->editParquetDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # ParquetDepot | parquetDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # edit Parquet Depot
    api_response = api_instance.edit_parquet_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->editParquetDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editParquetDepotHeader

edit Depot Header


/service/depots/parquet/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editParquetDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#editParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editParquetDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#editParquetDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editParquetDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editParquetDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editParquetDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editParquetDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.editParquetDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editParquetDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->editParquetDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editParquetDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->editParquetDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_parquet_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->editParquetDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editParquetExtractionFilter

edit Extraction Filter


/service/depots/parquet/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editParquetExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#editParquetExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editParquetExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#editParquetExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editParquetExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editParquetExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editParquetExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editParquetExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.editParquetExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editParquetExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->editParquetExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editParquetExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->editParquetExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_parquet_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->editParquetExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllParquetDepot

find All Parquet Depot


/service/depots/parquet

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[ParquetDepot] result = apiInstance.findAllParquetDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#findAllParquetDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[ParquetDepot] result = apiInstance.findAllParquetDepot(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#findAllParquetDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// find All Parquet Depot
[apiInstance findAllParquetDepotWith:project
              completionHandler: ^(array[ParquetDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllParquetDepot(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllParquetDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Parquet Depot
                array[ParquetDepot] result = apiInstance.findAllParquetDepot(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.findAllParquetDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllParquetDepot($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->findAllParquetDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllParquetDepot(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->findAllParquetDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # find All Parquet Depot
    api_response = api_instance.find_all_parquet_depot(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->findAllParquetDepot: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllParquetExtractionFilters

find All Extraction Filters


/service/depots/parquet/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllParquetExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#findAllParquetExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllParquetExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#findAllParquetExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllParquetExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllParquetExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllParquetExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllParquetExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.findAllParquetExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllParquetExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->findAllParquetExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllParquetExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->findAllParquetExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_parquet_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->findAllParquetExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneParquetDepotById

find One Parquet Depot By Id


/service/depots/parquet/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            ParquetDepot result = apiInstance.findOneParquetDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#findOneParquetDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            ParquetDepot result = apiInstance.findOneParquetDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#findOneParquetDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// find One Parquet Depot By Id
[apiInstance findOneParquetDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(ParquetDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneParquetDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneParquetDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // find One Parquet Depot By Id
                ParquetDepot result = apiInstance.findOneParquetDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.findOneParquetDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneParquetDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->findOneParquetDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneParquetDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->findOneParquetDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # find One Parquet Depot By Id
    api_response = api_instance.find_one_parquet_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->findOneParquetDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersFromParquetDepot

Get headers from a json depot


/service/depots/parquet/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/headers?ctx=&inferSchema=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ParquetDepot body = ; // ParquetDepot | parquetDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromParquetDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getHeadersFromParquetDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        ParquetDepot body = ; // ParquetDepot | parquetDepot
        Integer ctx = 56; // Integer | ctx
        Boolean inferSchema = true; // Boolean | inferSchema
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromParquetDepot(body, ctx, inferSchema, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getHeadersFromParquetDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ParquetDepot *body = ; // parquetDepot
Integer *ctx = 56; // ctx
Boolean *inferSchema = true; // inferSchema (optional)
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Get headers from a json depot
[apiInstance getHeadersFromParquetDepotWith:body
    ctx:ctx
    inferSchema:inferSchema
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{ParquetDepot}} parquetDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'inferSchema': true // {{Boolean}} inferSchema
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersFromParquetDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersFromParquetDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new ParquetDepot(); // ParquetDepot | parquetDepot
            var ctx = 56;  // Integer | ctx
            var inferSchema = true;  // Boolean | inferSchema (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a json depot
                array[array[Object]] result = apiInstance.getHeadersFromParquetDepot(body, ctx, inferSchema, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getHeadersFromParquetDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // ParquetDepot | parquetDepot
$ctx = 56; // Integer | ctx
$inferSchema = true; // Boolean | inferSchema
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHeadersFromParquetDepot($body, $ctx, $inferSchema, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getHeadersFromParquetDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ParquetDepot->new(); # ParquetDepot | parquetDepot
my $ctx = 56; # Integer | ctx
my $inferSchema = true; # Boolean | inferSchema
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHeadersFromParquetDepot(body => $body, ctx => $ctx, inferSchema => $inferSchema, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getHeadersFromParquetDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # ParquetDepot | parquetDepot
ctx = 56 # Integer | ctx
inferSchema = true # Boolean | inferSchema (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a json depot
    api_response = api_instance.get_headers_from_parquet_depot(body, ctx, inferSchema=inferSchema, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getHeadersFromParquetDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
inferSchema
Boolean
inferSchema
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetDepotExtractions

get Depot Extractions


/service/depots/parquet/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getParquetDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getParquetDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getParquetDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getParquetDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getParquetDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getParquetDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_parquet_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetDepotFilesCount

Get depot files count


/service/depots/parquet/{depotId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/count?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getParquetDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotFilesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getParquetDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotFilesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Get depot files count
[apiInstance getParquetDepotFilesCountWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetDepotFilesCount(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetDepotFilesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get depot files count
                Long result = apiInstance.getParquetDepotFilesCount(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetDepotFilesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getParquetDepotFilesCount($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetDepotFilesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getParquetDepotFilesCount(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetDepotFilesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get depot files count
    api_response = api_instance.get_parquet_depot_files_count(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetDepotFilesCount: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetDepotHeadersByDepotId

get Depot Headers By Depot Id


/service/depots/parquet/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getParquetDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getParquetDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// get Depot Headers By Depot Id
[apiInstance getParquetDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By Depot Id
                array[DepotHeader] result = apiInstance.getParquetDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getParquetDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getParquetDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By Depot Id
    api_response = api_instance.get_parquet_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetDepotRemoteFiles

Get parquet depot remoteFiles


/service/depots/parquet/{depotId}/remote_files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/remote_files?ctx=&filenameMask=&includeTemp=&limit=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getParquetDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getParquetDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *filenameMask = filenameMask_example; // filenameMask
Boolean *includeTemp = true; // includeTemp
Integer *limit = 56; // limit
Long *project = 789; // Project id (optional)
String *remotePath = remotePath_example; // remotePath (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Get parquet depot remoteFiles
[apiInstance getParquetDepotRemoteFilesWith:ctx
    depotId:depotId
    filenameMask:filenameMask
    includeTemp:includeTemp
    limit:limit
    project:project
    remotePath:remotePath
              completionHandler: ^(array[RemoteFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var filenameMask = filenameMask_example; // {{String}} filenameMask
var includeTemp = true; // {{Boolean}} includeTemp
var limit = 56; // {{Integer}} limit
var opts = { 
  'project': 789, // {{Long}} Project id
  'remotePath': remotePath_example // {{String}} remotePath
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetDepotRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var filenameMask = filenameMask_example;  // String | filenameMask
            var includeTemp = true;  // Boolean | includeTemp
            var limit = 56;  // Integer | limit
            var project = 789;  // Long | Project id (optional) 
            var remotePath = remotePath_example;  // String | remotePath (optional) 

            try
            {
                // Get parquet depot remoteFiles
                array[RemoteFile] result = apiInstance.getParquetDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetDepotRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$filenameMask = filenameMask_example; // String | filenameMask
$includeTemp = true; // Boolean | includeTemp
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$remotePath = remotePath_example; // String | remotePath

try {
    $result = $api_instance->getParquetDepotRemoteFiles($ctx, $depotId, $filenameMask, $includeTemp, $limit, $project, $remotePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetDepotRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $filenameMask = filenameMask_example; # String | filenameMask
my $includeTemp = true; # Boolean | includeTemp
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $remotePath = remotePath_example; # String | remotePath

eval { 
    my $result = $api_instance->getParquetDepotRemoteFiles(ctx => $ctx, depotId => $depotId, filenameMask => $filenameMask, includeTemp => $includeTemp, limit => $limit, project => $project, remotePath => $remotePath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetDepotRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
filenameMask = filenameMask_example # String | filenameMask
includeTemp = true # Boolean | includeTemp
limit = 56 # Integer | limit
project = 789 # Long | Project id (optional)
remotePath = remotePath_example # String | remotePath (optional)

try: 
    # Get parquet depot remoteFiles
    api_response = api_instance.get_parquet_depot_remote_files(ctx, depotId, filenameMask, includeTemp, limit, project=project, remotePath=remotePath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetDepotRemoteFiles: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filenameMask*
String
filenameMask
Required
includeTemp*
Boolean
includeTemp
Required
limit*
Integer (int32)
limit
Required
project
Long (int64)
Project id
remotePath
String
remotePath

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetExtractionFilePreview

get Extraction File Preview


/service/depots/parquet/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getParquetExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getParquetExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getParquetExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getParquetExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getParquetExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getParquetExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_parquet_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetFileDownloadToken

Get download token for a local PARQUET file


/service/depot/parquet/{depotId}/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/depot/parquet/{depotId}/file/token?fileName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getParquetFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetFileDownloadToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getParquetFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetFileDownloadToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Get download token for a local PARQUET file
[apiInstance getParquetFileDownloadTokenWith:depotId
    fileName:fileName
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetFileDownloadToken(depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetFileDownloadTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get download token for a local PARQUET file
                'String' result = apiInstance.getParquetFileDownloadToken(depotId, fileName, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetFileDownloadToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id

try {
    $result = $api_instance->getParquetFileDownloadToken($depotId, $fileName, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetFileDownloadToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getParquetFileDownloadToken(depotId => $depotId, fileName => $fileName, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetFileDownloadToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)

try: 
    # Get download token for a local PARQUET file
    api_response = api_instance.get_parquet_file_download_token(depotId, fileName, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetFileDownloadToken: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
fileName*
String
fileName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getParquetPreviewDepot

Get parquet depot


/service/depots/parquet/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Object result = apiInstance.getParquetPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Object result = apiInstance.getParquetPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#getParquetPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Get parquet depot
[apiInstance getParquetPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParquetPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getParquetPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get parquet depot
                Object result = apiInstance.getParquetPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.getParquetPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getParquetPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->getParquetPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getParquetPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->getParquetPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get parquet depot
    api_response = api_instance.get_parquet_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->getParquetPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleParquetFileUpload

Upload a parquet file to a depot


/service/depots/parquet/upload_file

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/upload_file?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleParquetFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#handleParquetFileUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleParquetFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#handleParquetFileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Upload a parquet file to a depot
[apiInstance handleParquetFileUploadWith:ctx
    project:project
              completionHandler: ^(FileUpload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleParquetFileUpload(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleParquetFileUploadExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Upload a parquet file to a depot
                FileUpload result = apiInstance.handleParquetFileUpload(ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.handleParquetFileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleParquetFileUpload($ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->handleParquetFileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleParquetFileUpload(ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->handleParquetFileUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Upload a parquet file to a depot
    api_response = api_instance.handle_parquet_file_upload(ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->handleParquetFileUpload: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveParquetDepotTempFolderOnTypeUpdate

move temp folder when type is changed


/service/depots/parquet/move_tmp_folder_on_type_update

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/parquet/move_tmp_folder_on_type_update?ctx=&depotCode=&newDepotType=&oldDepotType=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveParquetDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#moveParquetDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveParquetDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#moveParquetDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *depotCode = depotCode_example; // depotCode
String *newDepotType = newDepotType_example; // newDepotType
String *oldDepotType = oldDepotType_example; // oldDepotType
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// move temp folder when type is changed
[apiInstance moveParquetDepotTempFolderOnTypeUpdateWith:ctx
    depotCode:depotCode
    newDepotType:newDepotType
    oldDepotType:oldDepotType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotCode = depotCode_example; // {{String}} depotCode
var newDepotType = newDepotType_example; // {{String}} newDepotType
var oldDepotType = oldDepotType_example; // {{String}} oldDepotType
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveParquetDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveParquetDepotTempFolderOnTypeUpdateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotCode = depotCode_example;  // String | depotCode
            var newDepotType = newDepotType_example;  // String | newDepotType
            var oldDepotType = oldDepotType_example;  // String | oldDepotType
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // move temp folder when type is changed
                apiInstance.moveParquetDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.moveParquetDepotTempFolderOnTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotCode = depotCode_example; // String | depotCode
$newDepotType = newDepotType_example; // String | newDepotType
$oldDepotType = oldDepotType_example; // String | oldDepotType
$project = 789; // Long | Project id

try {
    $api_instance->moveParquetDepotTempFolderOnTypeUpdate($ctx, $depotCode, $newDepotType, $oldDepotType, $project);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->moveParquetDepotTempFolderOnTypeUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotCode = depotCode_example; # String | depotCode
my $newDepotType = newDepotType_example; # String | newDepotType
my $oldDepotType = oldDepotType_example; # String | oldDepotType
my $project = 789; # Long | Project id

eval { 
    $api_instance->moveParquetDepotTempFolderOnTypeUpdate(ctx => $ctx, depotCode => $depotCode, newDepotType => $newDepotType, oldDepotType => $oldDepotType, project => $project);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->moveParquetDepotTempFolderOnTypeUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotCode = depotCode_example # String | depotCode
newDepotType = newDepotType_example # String | newDepotType
oldDepotType = oldDepotType_example # String | oldDepotType
project = 789 # Long | Project id (optional)

try: 
    # move temp folder when type is changed
    api_instance.move_parquet_depot_temp_folder_on_type_update(ctx, depotCode, newDepotType, oldDepotType, project=project)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->moveParquetDepotTempFolderOnTypeUpdate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotCode*
String
depotCode
Required
newDepotType*
String
newDepotType
Required
oldDepotType*
String
oldDepotType
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


previewRemoteParquetFile

Get parquet depot file preview


/service/depots/parquet/{depotId}/remote_files/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/parquet/{depotId}/remote_files/preview?ctx=&fileName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteParquetFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#previewRemoteParquetFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteParquetFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#previewRemoteParquetFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// Get parquet depot file preview
[apiInstance previewRemoteParquetFileWith:ctx
    depotId:depotId
    fileName:fileName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewRemoteParquetFile(ctx, depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewRemoteParquetFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Get parquet depot file preview
                DepotData result = apiInstance.previewRemoteParquetFile(ctx, depotId, fileName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.previewRemoteParquetFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->previewRemoteParquetFile($ctx, $depotId, $fileName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->previewRemoteParquetFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->previewRemoteParquetFile(ctx => $ctx, depotId => $depotId, fileName => $fileName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->previewRemoteParquetFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Get parquet depot file preview
    api_response = api_instance.preview_remote_parquet_file(ctx, depotId, fileName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->previewRemoteParquetFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateParquetDepotActivationStatus

update Depot Activation Status


/service/depots/parquet/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/parquet/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateParquetDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#updateParquetDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateParquetDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#updateParquetDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateParquetDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateParquetDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateParquetDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateParquetDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.updateParquetDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateParquetDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->updateParquetDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateParquetDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->updateParquetDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_parquet_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->updateParquetDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateParquetDepotHeadersPositions

update Depot Headers Positions


/service/depots/parquet/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/parquet/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParquetDepotControllerApi;

import java.io.File;
import java.util.*;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateParquetDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#updateParquetDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParquetDepotControllerApi;

public class ParquetDepotControllerApiExample {

    public static void main(String[] args) {
        ParquetDepotControllerApi apiInstance = new ParquetDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateParquetDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParquetDepotControllerApi#updateParquetDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ParquetDepotControllerApi *apiInstance = [[ParquetDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateParquetDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ParquetDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateParquetDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateParquetDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ParquetDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateParquetDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParquetDepotControllerApi.updateParquetDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiParquetDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateParquetDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling ParquetDepotControllerApi->updateParquetDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParquetDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ParquetDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateParquetDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling ParquetDepotControllerApi->updateParquetDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ParquetDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_parquet_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling ParquetDepotControllerApi->updateParquetDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


PdfMediaController

checkConfigUsingGET8

Check the configuration informations of an existing media


/service/medias/pdf/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/pdf/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET8(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#checkConfigUsingGET8");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET8(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#checkConfigUsingGET8");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdMedia Id
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Check the configuration informations of an existing media
[apiInstance checkConfigUsingGET8With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var id = 789; // {{Long}} HdMedia Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET8(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET8Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var id = 789;  // Long | HdMedia Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing media
                'Boolean' result = apiInstance.checkConfigUsingGET8(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.checkConfigUsingGET8: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$id = 789; // Long | HdMedia Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET8($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->checkConfigUsingGET8: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $id = 789; # Long | HdMedia Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET8(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->checkConfigUsingGET8: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
id = 789 # Long | HdMedia Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing media
    api_response = api_instance.check_config_using_get8(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->checkConfigUsingGET8: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMedia Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createPdfMedia

Create a new media

Create a new media and returns the new generated id


/service/medias/pdf

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/pdf?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        CreateMediaEntry body = ; // CreateMediaEntry | media
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPdfMedia(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#createPdfMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        CreateMediaEntry body = ; // CreateMediaEntry | media
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPdfMedia(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#createPdfMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateMediaEntry *body = ; // media
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Create a new media
[apiInstance createPdfMediaWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var body = ; // {{CreateMediaEntry}} media
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPdfMedia(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPdfMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var body = new CreateMediaEntry(); // CreateMediaEntry | media
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new media
                Long result = apiInstance.createPdfMedia(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.createPdfMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$body = ; // CreateMediaEntry | media
$project = 789; // Long | Project id

try {
    $result = $api_instance->createPdfMedia($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->createPdfMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateMediaEntry->new(); # CreateMediaEntry | media
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createPdfMedia(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->createPdfMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
body =  # CreateMediaEntry | media
project = 789 # Long | Project id (optional)

try: 
    # Create a new media
    api_response = api_instance.create_pdf_media(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->createPdfMedia: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createPdfMediaFromDb

Create a new media from datablock

Create a new media from datablock and returns the new generated id


/service/medias/pdf/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/pdf/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        CreateMediaFromDbEntry body = ; // CreateMediaFromDbEntry | the new media data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPdfMediaFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#createPdfMediaFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        CreateMediaFromDbEntry body = ; // CreateMediaFromDbEntry | the new media data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPdfMediaFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#createPdfMediaFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateMediaFromDbEntry *body = ; // the new media data
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Create a new media from datablock
[apiInstance createPdfMediaFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var body = ; // {{CreateMediaFromDbEntry}} the new media data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPdfMediaFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPdfMediaFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var body = new CreateMediaFromDbEntry(); // CreateMediaFromDbEntry | the new media data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new media from datablock
                Long result = apiInstance.createPdfMediaFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.createPdfMediaFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$body = ; // CreateMediaFromDbEntry | the new media data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createPdfMediaFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->createPdfMediaFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateMediaFromDbEntry->new(); # CreateMediaFromDbEntry | the new media data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createPdfMediaFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->createPdfMediaFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
body =  # CreateMediaFromDbEntry | the new media data
project = 789 # Long | Project id (optional)

try: 
    # Create a new media from datablock
    api_response = api_instance.create_pdf_media_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->createPdfMediaFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deletePdfMedia

Delete an existing media


/service/medias/pdf/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/medias/pdf/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePdfMedia(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#deletePdfMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePdfMedia(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#deletePdfMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the media to be deleted
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Delete an existing media
[apiInstance deletePdfMediaWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var id = 789; // {{Long}} The Id of the media to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePdfMedia(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePdfMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var id = 789;  // Long | The Id of the media to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing media
                apiInstance.deletePdfMedia(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.deletePdfMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$id = 789; // Long | The Id of the media to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deletePdfMedia($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->deletePdfMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $id = 789; # Long | The Id of the media to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deletePdfMedia(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->deletePdfMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
id = 789 # Long | The Id of the media to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing media
    api_instance.delete_pdf_media(id, project=project)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->deletePdfMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the media to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicatePdfMedia

Duplicate an existing media


/service/medias/pdf/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/medias/pdf/{id}/duplicate?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicatePdfMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#duplicatePdfMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | The Id of the media to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicatePdfMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#duplicatePdfMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the media to be duplicated
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Duplicate an existing media
[apiInstance duplicatePdfMediaWith:id
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var id = 789; // {{Long}} The Id of the media to be duplicated
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicatePdfMedia(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicatePdfMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var id = 789;  // Long | The Id of the media to be duplicated
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Duplicate an existing media
                Long result = apiInstance.duplicatePdfMedia(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.duplicatePdfMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$id = 789; // Long | The Id of the media to be duplicated
$project = 789; // Long | Project id

try {
    $result = $api_instance->duplicatePdfMedia($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->duplicatePdfMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $id = 789; # Long | The Id of the media to be duplicated
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->duplicatePdfMedia(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->duplicatePdfMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
id = 789 # Long | The Id of the media to be duplicated
project = 789 # Long | Project id (optional)

try: 
    # Duplicate an existing media
    api_response = api_instance.duplicate_pdf_media(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->duplicatePdfMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the media to be duplicated
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editPdfMedia

Edit media

Edit an existing media


/service/medias/pdf/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/pdf/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        UpdateMediaEntry body = ; // UpdateMediaEntry | Update media data
        Long id = 789; // Long | Id of media to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPdfMedia(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#editPdfMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        UpdateMediaEntry body = ; // UpdateMediaEntry | Update media data
        Long id = 789; // Long | Id of media to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPdfMedia(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#editPdfMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateMediaEntry *body = ; // Update media data
Long *id = 789; // Id of media to update data
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Edit media
[apiInstance editPdfMediaWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var body = ; // {{UpdateMediaEntry}} Update media data
var id = 789; // {{Long}} Id of media to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editPdfMedia(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPdfMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var body = new UpdateMediaEntry(); // UpdateMediaEntry | Update media data
            var id = 789;  // Long | Id of media to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit media
                apiInstance.editPdfMedia(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.editPdfMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$body = ; // UpdateMediaEntry | Update media data
$id = 789; // Long | Id of media to update data
$project = 789; // Long | Project id

try {
    $api_instance->editPdfMedia($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->editPdfMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateMediaEntry->new(); # UpdateMediaEntry | Update media data
my $id = 789; # Long | Id of media to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editPdfMedia(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->editPdfMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
body =  # UpdateMediaEntry | Update media data
id = 789 # Long | Id of media to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit media
    api_instance.edit_pdf_media(body, id, project=project)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->editPdfMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of media to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editPdfMediaConfig

Update the configuration informations of an existing media


/service/medias/pdf/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/medias/pdf/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        UpdatePdfMediaConfigEntry body = ; // UpdatePdfMediaConfigEntry | The update configuration data
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPdfMediaConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#editPdfMediaConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        UpdatePdfMediaConfigEntry body = ; // UpdatePdfMediaConfigEntry | The update configuration data
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPdfMediaConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#editPdfMediaConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdatePdfMediaConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdMedia Id
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Update the configuration informations of an existing media
[apiInstance editPdfMediaConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var body = ; // {{UpdatePdfMediaConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdMedia Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editPdfMediaConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPdfMediaConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var body = new UpdatePdfMediaConfigEntry(); // UpdatePdfMediaConfigEntry | The update configuration data
            var id = 789;  // Long | HdMedia Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing media
                apiInstance.editPdfMediaConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.editPdfMediaConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$body = ; // UpdatePdfMediaConfigEntry | The update configuration data
$id = 789; // Long | HdMedia Id
$project = 789; // Long | Project id

try {
    $api_instance->editPdfMediaConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->editPdfMediaConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePdfMediaConfigEntry->new(); # UpdatePdfMediaConfigEntry | The update configuration data
my $id = 789; # Long | HdMedia Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editPdfMediaConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->editPdfMediaConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
body =  # UpdatePdfMediaConfigEntry | The update configuration data
id = 789 # Long | HdMedia Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing media
    api_instance.edit_pdf_media_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->editPdfMediaConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMedia Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getPdfMedia

Get a media by Id


/service/medias/pdf/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/pdf/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | Requested media Id
        Long project = 789; // Long | Project id
        try {
            HdMedia result = apiInstance.getPdfMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#getPdfMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | Requested media Id
        Long project = 789; // Long | Project id
        try {
            HdMedia result = apiInstance.getPdfMedia(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#getPdfMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested media Id
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Get a media by Id
[apiInstance getPdfMediaWith:id
    project:project
              completionHandler: ^(HdMedia output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var id = 789; // {{Long}} Requested media Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPdfMedia(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPdfMediaExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var id = 789;  // Long | Requested media Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a media by Id
                HdMedia result = apiInstance.getPdfMedia(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.getPdfMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$id = 789; // Long | Requested media Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPdfMedia($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->getPdfMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $id = 789; # Long | Requested media Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPdfMedia(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->getPdfMedia: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
id = 789 # Long | Requested media Id
project = 789 # Long | Project id (optional)

try: 
    # Get a media by Id
    api_response = api_instance.get_pdf_media(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->getPdfMedia: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested media Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getPdfMediaConfig

Get the configuration informations of an existing media


/service/medias/pdf/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/medias/pdf/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PdfMediaControllerApi;

import java.io.File;
import java.util.*;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            PdfMediaConfig result = apiInstance.getPdfMediaConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#getPdfMediaConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PdfMediaControllerApi;

public class PdfMediaControllerApiExample {

    public static void main(String[] args) {
        PdfMediaControllerApi apiInstance = new PdfMediaControllerApi();
        Long id = 789; // Long | HdMedia Id
        Long project = 789; // Long | Project id
        try {
            PdfMediaConfig result = apiInstance.getPdfMediaConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PdfMediaControllerApi#getPdfMediaConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdMedia Id
Long *project = 789; // Project id (optional)

PdfMediaControllerApi *apiInstance = [[PdfMediaControllerApi alloc] init];

// Get the configuration informations of an existing media
[apiInstance getPdfMediaConfigWith:id
    project:project
              completionHandler: ^(PdfMediaConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PdfMediaControllerApi()
var id = 789; // {{Long}} HdMedia Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPdfMediaConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPdfMediaConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PdfMediaControllerApi();
            var id = 789;  // Long | HdMedia Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing media
                PdfMediaConfig result = apiInstance.getPdfMediaConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PdfMediaControllerApi.getPdfMediaConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPdfMediaControllerApi();
$id = 789; // Long | HdMedia Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPdfMediaConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PdfMediaControllerApi->getPdfMediaConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PdfMediaControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PdfMediaControllerApi->new();
my $id = 789; # Long | HdMedia Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPdfMediaConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PdfMediaControllerApi->getPdfMediaConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PdfMediaControllerApi()
id = 789 # Long | HdMedia Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing media
    api_response = api_instance.get_pdf_media_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PdfMediaControllerApi->getPdfMediaConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdMedia Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


PieChartController

checkConfigUsingGET9

Check the configuration informations of an existing chart


/service/charts/pie/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/pie/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET9(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#checkConfigUsingGET9");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET9(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#checkConfigUsingGET9");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET9With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET9(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET9Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET9(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.checkConfigUsingGET9: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET9($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->checkConfigUsingGET9: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET9(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->checkConfigUsingGET9: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get9(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->checkConfigUsingGET9: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createPieChart

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/pie/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/pie/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPieChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#createPieChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPieChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#createPieChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createPieChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPieChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPieChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createPieChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.createPieChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createPieChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->createPieChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createPieChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->createPieChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_pie_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->createPieChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createPieChartFromDb

Create a new chart

Create a new chart and returns the new generated id


/service/charts/pie

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/pie?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPieChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#createPieChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createPieChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#createPieChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Create a new chart
[apiInstance createPieChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPieChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPieChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createPieChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.createPieChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createPieChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->createPieChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createPieChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->createPieChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_pie_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->createPieChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deletePieChart

Delete an existing chart


/service/charts/pie/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/pie/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePieChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#deletePieChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deletePieChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#deletePieChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deletePieChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePieChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePieChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deletePieChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.deletePieChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deletePieChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->deletePieChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deletePieChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->deletePieChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_pie_chart(id, project=project)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->deletePieChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicatePieChart

Duplicate an existing chart


/service/charts/pie/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/pie/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicatePieChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#duplicatePieChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicatePieChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#duplicatePieChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicatePieChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicatePieChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicatePieChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicatePieChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.duplicatePieChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicatePieChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->duplicatePieChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicatePieChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->duplicatePieChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_pie_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->duplicatePieChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editPieChart

Edit chart

Edit an existing chart


/service/charts/pie/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/pie/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPieChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#editPieChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPieChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#editPieChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Edit chart
[apiInstance editPieChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editPieChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPieChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editPieChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.editPieChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editPieChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->editPieChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editPieChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->editPieChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_pie_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->editPieChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editPieChartConfig

Update the configuration informations of an existing chart


/service/charts/pie/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/pie/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        UpdatePieChartConfigEntry body = ; // UpdatePieChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPieChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#editPieChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        UpdatePieChartConfigEntry body = ; // UpdatePieChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editPieChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#editPieChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdatePieChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editPieChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var body = ; // {{UpdatePieChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editPieChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPieChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var body = new UpdatePieChartConfigEntry(); // UpdatePieChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editPieChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.editPieChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$body = ; // UpdatePieChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editPieChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->editPieChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePieChartConfigEntry->new(); # UpdatePieChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editPieChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->editPieChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
body =  # UpdatePieChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_pie_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->editPieChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getPieChart

Get a chart by Id


/service/charts/pie/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/pie/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getPieChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#getPieChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getPieChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#getPieChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getPieChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPieChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPieChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getPieChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.getPieChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPieChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->getPieChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPieChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->getPieChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_pie_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->getPieChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getPieChartConfig

Get the configuration informations of an existing chart


/service/charts/pie/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/pie/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PieChartControllerApi;

import java.io.File;
import java.util.*;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            PieChartConfig result = apiInstance.getPieChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#getPieChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PieChartControllerApi;

public class PieChartControllerApiExample {

    public static void main(String[] args) {
        PieChartControllerApi apiInstance = new PieChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            PieChartConfig result = apiInstance.getPieChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PieChartControllerApi#getPieChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

PieChartControllerApi *apiInstance = [[PieChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getPieChartConfigWith:id
    project:project
              completionHandler: ^(PieChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PieChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPieChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPieChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PieChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                PieChartConfig result = apiInstance.getPieChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PieChartControllerApi.getPieChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPieChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getPieChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PieChartControllerApi->getPieChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PieChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PieChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getPieChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PieChartControllerApi->getPieChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PieChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_pie_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PieChartControllerApi->getPieChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


PivotGridController

checkConfigUsingGET10

Check the configuration informations of an existing grid


/service/grids/pivot/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/pivot/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET10(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#checkConfigUsingGET10");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET10(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#checkConfigUsingGET10");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdGrid Id
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Check the configuration informations of an existing grid
[apiInstance checkConfigUsingGET10With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var id = 789; // {{Long}} HdGrid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET10(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET10Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var id = 789;  // Long | HdGrid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing grid
                'Boolean' result = apiInstance.checkConfigUsingGET10(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.checkConfigUsingGET10: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$id = 789; // Long | HdGrid Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET10($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->checkConfigUsingGET10: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $id = 789; # Long | HdGrid Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET10(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->checkConfigUsingGET10: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
id = 789 # Long | HdGrid Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing grid
    api_response = api_instance.check_config_using_get10(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->checkConfigUsingGET10: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdGrid Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createFromDbUsingPOST

Create a new grid from datablock

Create a new grid from datablock and returns the new generated id


/service/grids/pivot/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/pivot/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long body = ; // Long | Datablock Id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFromDbUsingPOST(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#createFromDbUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long body = ; // Long | Datablock Id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFromDbUsingPOST(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#createFromDbUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *body = ; // Datablock Id
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Create a new grid from datablock
[apiInstance createFromDbUsingPOSTWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var body = ; // {{Long}} Datablock Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFromDbUsingPOST(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFromDbUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var body = new Long(); // Long | Datablock Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new grid from datablock
                Long result = apiInstance.createFromDbUsingPOST(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.createFromDbUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$body = ; // Long | Datablock Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->createFromDbUsingPOST($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->createFromDbUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | Datablock Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createFromDbUsingPOST(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->createFromDbUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
body =  # Long | Datablock Id
project = 789 # Long | Project id (optional)

try: 
    # Create a new grid from datablock
    api_response = api_instance.create_from_db_using_post(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->createFromDbUsingPOST: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createUsingPOST

Create a new grid

Create a new grid and returns the new generated id


/service/grids/pivot

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/pivot?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        CreateGridEntry body = ; // CreateGridEntry | grid
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createUsingPOST(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#createUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        CreateGridEntry body = ; // CreateGridEntry | grid
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createUsingPOST(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#createUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateGridEntry *body = ; // grid
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Create a new grid
[apiInstance createUsingPOSTWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var body = ; // {{CreateGridEntry}} grid
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUsingPOST(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var body = new CreateGridEntry(); // CreateGridEntry | grid
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new grid
                Long result = apiInstance.createUsingPOST(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.createUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$body = ; // CreateGridEntry | grid
$project = 789; // Long | Project id

try {
    $result = $api_instance->createUsingPOST($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->createUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateGridEntry->new(); # CreateGridEntry | grid
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createUsingPOST(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->createUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
body =  # CreateGridEntry | grid
project = 789 # Long | Project id (optional)

try: 
    # Create a new grid
    api_response = api_instance.create_using_post(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->createUsingPOST: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteUsingDELETE

Delete an existing grid


/service/grids/pivot/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/grids/pivot/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteUsingDELETE(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#deleteUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteUsingDELETE(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#deleteUsingDELETE");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the grid to be deleted
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Delete an existing grid
[apiInstance deleteUsingDELETEWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var id = 789; // {{Long}} The Id of the grid to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUsingDELETE(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUsingDELETEExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var id = 789;  // Long | The Id of the grid to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing grid
                apiInstance.deleteUsingDELETE(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.deleteUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$id = 789; // Long | The Id of the grid to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteUsingDELETE($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->deleteUsingDELETE: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $id = 789; # Long | The Id of the grid to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteUsingDELETE(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->deleteUsingDELETE: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
id = 789 # Long | The Id of the grid to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing grid
    api_instance.delete_using_delete(id, project=project)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->deleteUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the grid to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateUsingPOST

Duplicate an existing grid


/service/grids/pivot/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/grids/pivot/{id}/duplicate?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateUsingPOST(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#duplicateUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateUsingPOST(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#duplicateUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the grid to be duplicated
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Duplicate an existing grid
[apiInstance duplicateUsingPOSTWith:id
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var id = 789; // {{Long}} The Id of the grid to be duplicated
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateUsingPOST(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var id = 789;  // Long | The Id of the grid to be duplicated
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Duplicate an existing grid
                Long result = apiInstance.duplicateUsingPOST(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.duplicateUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$id = 789; // Long | The Id of the grid to be duplicated
$project = 789; // Long | Project id

try {
    $result = $api_instance->duplicateUsingPOST($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->duplicateUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $id = 789; # Long | The Id of the grid to be duplicated
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->duplicateUsingPOST(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->duplicateUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
id = 789 # Long | The Id of the grid to be duplicated
project = 789 # Long | Project id (optional)

try: 
    # Duplicate an existing grid
    api_response = api_instance.duplicate_using_post(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->duplicateUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the grid to be duplicated
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editConfigUsingPUT

Update the configuration informations of an existing grid


/service/grids/pivot/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/pivot/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        UpdatePivotGridConfigEntry body = ; // UpdatePivotGridConfigEntry | The update configuration data
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editConfigUsingPUT(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#editConfigUsingPUT");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        UpdatePivotGridConfigEntry body = ; // UpdatePivotGridConfigEntry | The update configuration data
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editConfigUsingPUT(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#editConfigUsingPUT");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdatePivotGridConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdGrid Id
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Update the configuration informations of an existing grid
[apiInstance editConfigUsingPUTWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var body = ; // {{UpdatePivotGridConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdGrid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editConfigUsingPUT(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editConfigUsingPUTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var body = new UpdatePivotGridConfigEntry(); // UpdatePivotGridConfigEntry | The update configuration data
            var id = 789;  // Long | HdGrid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing grid
                apiInstance.editConfigUsingPUT(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.editConfigUsingPUT: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$body = ; // UpdatePivotGridConfigEntry | The update configuration data
$id = 789; // Long | HdGrid Id
$project = 789; // Long | Project id

try {
    $api_instance->editConfigUsingPUT($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->editConfigUsingPUT: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePivotGridConfigEntry->new(); # UpdatePivotGridConfigEntry | The update configuration data
my $id = 789; # Long | HdGrid Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editConfigUsingPUT(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->editConfigUsingPUT: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
body =  # UpdatePivotGridConfigEntry | The update configuration data
id = 789 # Long | HdGrid Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing grid
    api_instance.edit_config_using_put(body, id, project=project)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->editConfigUsingPUT: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdGrid Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editUsingPUT

Edit grid

Edit an existing grid


/service/grids/pivot/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/pivot/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        UpdateGridEntry body = ; // UpdateGridEntry | Update grid data
        Long id = 789; // Long | Id of grid to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editUsingPUT(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#editUsingPUT");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        UpdateGridEntry body = ; // UpdateGridEntry | Update grid data
        Long id = 789; // Long | Id of grid to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editUsingPUT(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#editUsingPUT");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateGridEntry *body = ; // Update grid data
Long *id = 789; // Id of grid to update data
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Edit grid
[apiInstance editUsingPUTWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var body = ; // {{UpdateGridEntry}} Update grid data
var id = 789; // {{Long}} Id of grid to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editUsingPUT(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editUsingPUTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var body = new UpdateGridEntry(); // UpdateGridEntry | Update grid data
            var id = 789;  // Long | Id of grid to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit grid
                apiInstance.editUsingPUT(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.editUsingPUT: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$body = ; // UpdateGridEntry | Update grid data
$id = 789; // Long | Id of grid to update data
$project = 789; // Long | Project id

try {
    $api_instance->editUsingPUT($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->editUsingPUT: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateGridEntry->new(); # UpdateGridEntry | Update grid data
my $id = 789; # Long | Id of grid to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editUsingPUT(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->editUsingPUT: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
body =  # UpdateGridEntry | Update grid data
id = 789 # Long | Id of grid to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit grid
    api_instance.edit_using_put(body, id, project=project)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->editUsingPUT: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of grid to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getConfigUsingGET

Get the configuration informations of an existing grid


/service/grids/pivot/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/pivot/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            PivotGridConfig result = apiInstance.getConfigUsingGET(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#getConfigUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            PivotGridConfig result = apiInstance.getConfigUsingGET(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#getConfigUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdGrid Id
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Get the configuration informations of an existing grid
[apiInstance getConfigUsingGETWith:id
    project:project
              completionHandler: ^(PivotGridConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var id = 789; // {{Long}} HdGrid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfigUsingGET(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConfigUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var id = 789;  // Long | HdGrid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing grid
                PivotGridConfig result = apiInstance.getConfigUsingGET(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.getConfigUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$id = 789; // Long | HdGrid Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getConfigUsingGET($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->getConfigUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $id = 789; # Long | HdGrid Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getConfigUsingGET(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->getConfigUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
id = 789 # Long | HdGrid Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing grid
    api_response = api_instance.get_config_using_get(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->getConfigUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdGrid Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getUsingGET

Get a grid by Id


/service/grids/pivot/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/pivot/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PivotGridControllerApi;

import java.io.File;
import java.util.*;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | Requested grid Id
        Long project = 789; // Long | Project id
        try {
            HdGrid result = apiInstance.getUsingGET(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#getUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PivotGridControllerApi;

public class PivotGridControllerApiExample {

    public static void main(String[] args) {
        PivotGridControllerApi apiInstance = new PivotGridControllerApi();
        Long id = 789; // Long | Requested grid Id
        Long project = 789; // Long | Project id
        try {
            HdGrid result = apiInstance.getUsingGET(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PivotGridControllerApi#getUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested grid Id
Long *project = 789; // Project id (optional)

PivotGridControllerApi *apiInstance = [[PivotGridControllerApi alloc] init];

// Get a grid by Id
[apiInstance getUsingGETWith:id
    project:project
              completionHandler: ^(HdGrid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.PivotGridControllerApi()
var id = 789; // {{Long}} Requested grid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsingGET(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PivotGridControllerApi();
            var id = 789;  // Long | Requested grid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a grid by Id
                HdGrid result = apiInstance.getUsingGET(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PivotGridControllerApi.getUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPivotGridControllerApi();
$id = 789; // Long | Requested grid Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getUsingGET($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PivotGridControllerApi->getUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PivotGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PivotGridControllerApi->new();
my $id = 789; # Long | Requested grid Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getUsingGET(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PivotGridControllerApi->getUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PivotGridControllerApi()
id = 789 # Long | Requested grid Id
project = 789 # Long | Project id (optional)

try: 
    # Get a grid by Id
    api_response = api_instance.get_using_get(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PivotGridControllerApi->getUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested grid Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ProjectBulkExecutionController

cancelDuplication

Cancel project duplication


/service/projects/{id}/duplicate/{executionId}/cancel

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/duplicate/{executionId}/cancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            apiInstance.cancelDuplication(executionId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#cancelDuplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            apiInstance.cancelDuplication(executionId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#cancelDuplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // Execution id
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Cancel project duplication
[apiInstance cancelDuplicationWith:executionId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} Execution id
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelDuplication(executionId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelDuplicationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | Execution id
            var id = 789;  // Long | Project id

            try
            {
                // Cancel project duplication
                apiInstance.cancelDuplication(executionId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.cancelDuplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | Execution id
$id = 789; // Long | Project id

try {
    $api_instance->cancelDuplication($executionId, $id);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->cancelDuplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | Execution id
my $id = 789; # Long | Project id

eval { 
    $api_instance->cancelDuplication(executionId => $executionId, id => $id);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->cancelDuplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | Execution id
id = 789 # Long | Project id

try: 
    # Cancel project duplication
    api_instance.cancel_duplication(executionId, id)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->cancelDuplication: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
Execution id
Required
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


cancelExport

Cancel project export


/service/projects/{id}/export/{executionId}/cancel

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/export/{executionId}/cancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            apiInstance.cancelExport(executionId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#cancelExport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            apiInstance.cancelExport(executionId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#cancelExport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // Execution id
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Cancel project export
[apiInstance cancelExportWith:executionId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} Execution id
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelExport(executionId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelExportExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | Execution id
            var id = 789;  // Long | Project id

            try
            {
                // Cancel project export
                apiInstance.cancelExport(executionId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.cancelExport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | Execution id
$id = 789; // Long | Project id

try {
    $api_instance->cancelExport($executionId, $id);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->cancelExport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | Execution id
my $id = 789; # Long | Project id

eval { 
    $api_instance->cancelExport(executionId => $executionId, id => $id);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->cancelExport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | Execution id
id = 789 # Long | Project id

try: 
    # Cancel project export
    api_instance.cancel_export(executionId, id)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->cancelExport: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
Execution id
Required
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


cancelImport

Cancel project import


/service/projects/import/{executionId}/cancel

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/projects/import/{executionId}/cancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        try {
            apiInstance.cancelImport(executionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#cancelImport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        try {
            apiInstance.cancelImport(executionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#cancelImport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // Execution id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Cancel project import
[apiInstance cancelImportWith:executionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} Execution id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelImport(executionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelImportExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | Execution id

            try
            {
                // Cancel project import
                apiInstance.cancelImport(executionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.cancelImport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | Execution id

try {
    $api_instance->cancelImport($executionId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->cancelImport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | Execution id

eval { 
    $api_instance->cancelImport(executionId => $executionId);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->cancelImport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | Execution id

try: 
    # Cancel project import
    api_instance.cancel_import(executionId)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->cancelImport: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
Execution id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


downloadExportedProjectFile

Download Exported Project File


/service/projects/export/download/{executionId}/{link}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/export/download/{executionId}/{link}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | executionId
        String link = link_example; // String | link
        try {
            apiInstance.downloadExportedProjectFile(executionId, link);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#downloadExportedProjectFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | executionId
        String link = link_example; // String | link
        try {
            apiInstance.downloadExportedProjectFile(executionId, link);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#downloadExportedProjectFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // executionId
String *link = link_example; // link

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Download Exported Project File
[apiInstance downloadExportedProjectFileWith:executionId
    link:link
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} executionId
var link = link_example; // {{String}} link

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadExportedProjectFile(executionId, link, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadExportedProjectFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | executionId
            var link = link_example;  // String | link

            try
            {
                // Download Exported Project File
                apiInstance.downloadExportedProjectFile(executionId, link);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.downloadExportedProjectFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | executionId
$link = link_example; // String | link

try {
    $api_instance->downloadExportedProjectFile($executionId, $link);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->downloadExportedProjectFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | executionId
my $link = link_example; # String | link

eval { 
    $api_instance->downloadExportedProjectFile(executionId => $executionId, link => $link);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->downloadExportedProjectFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | executionId
link = link_example # String | link

try: 
    # Download Exported Project File
    api_instance.download_exported_project_file(executionId, link)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->downloadExportedProjectFile: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
executionId
Required
link*

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


duplicateProject

Duplicate project


/service/projects/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/text"\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        ProjectDuplicationOptions body = ; // ProjectDuplicationOptions | Duplication options
        Long id = 789; // Long | Project id
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            'String' result = apiInstance.duplicateProject(body, id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#duplicateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        ProjectDuplicationOptions body = ; // ProjectDuplicationOptions | Duplication options
        Long id = 789; // Long | Project id
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            'String' result = apiInstance.duplicateProject(body, id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#duplicateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ProjectDuplicationOptions *body = ; // Duplication options
Long *id = 789; // Project id
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Duplicate project
[apiInstance duplicateProjectWith:body
    id:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var body = ; // {{ProjectDuplicationOptions}} Duplication options
var id = 789; // {{Long}} Project id
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateProject(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var body = new ProjectDuplicationOptions(); // ProjectDuplicationOptions | Duplication options
            var id = 789;  // Long | Project id
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate project
                'String' result = apiInstance.duplicateProject(body, id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.duplicateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$body = ; // ProjectDuplicationOptions | Duplication options
$id = 789; // Long | Project id
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateProject($body, $id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->duplicateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $body = WWW::SwaggerClient::Object::ProjectDuplicationOptions->new(); # ProjectDuplicationOptions | Duplication options
my $id = 789; # Long | Project id
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateProject(body => $body, id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->duplicateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
body =  # ProjectDuplicationOptions | Duplication options
id = 789 # Long | Project id
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate project
    api_response = api_instance.duplicate_project(body, id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->duplicateProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


exportProject

Export project


/service/projects/{id}/export

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/text"\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/{id}/export?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        ProjectFileExportOptions body = ; // ProjectFileExportOptions | Export options
        Long id = 789; // Long | Project id
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            'String' result = apiInstance.exportProject(body, id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#exportProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        ProjectFileExportOptions body = ; // ProjectFileExportOptions | Export options
        Long id = 789; // Long | Project id
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            'String' result = apiInstance.exportProject(body, id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#exportProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ProjectFileExportOptions *body = ; // Export options
Long *id = 789; // Project id
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Export project
[apiInstance exportProjectWith:body
    id:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var body = ; // {{ProjectFileExportOptions}} Export options
var id = 789; // {{Long}} Project id
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportProject(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var body = new ProjectFileExportOptions(); // ProjectFileExportOptions | Export options
            var id = 789;  // Long | Project id
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Export project
                'String' result = apiInstance.exportProject(body, id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.exportProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$body = ; // ProjectFileExportOptions | Export options
$id = 789; // Long | Project id
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->exportProject($body, $id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->exportProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $body = WWW::SwaggerClient::Object::ProjectFileExportOptions->new(); # ProjectFileExportOptions | Export options
my $id = 789; # Long | Project id
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->exportProject(body => $body, id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->exportProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
body =  # ProjectFileExportOptions | Export options
id = 789 # Long | Project id
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Export project
    api_response = api_instance.export_project(body, id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->exportProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCurrentDuplicationExecution

Get current duplication execution id


/service/projects/{id}/current_duplication_execution_id

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/projects/{id}/current_duplication_execution_id"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        Long id = 789; // Long | Project id
        try {
            'String' result = apiInstance.getCurrentDuplicationExecution(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getCurrentDuplicationExecution");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        Long id = 789; // Long | Project id
        try {
            'String' result = apiInstance.getCurrentDuplicationExecution(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getCurrentDuplicationExecution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get current duplication execution id
[apiInstance getCurrentDuplicationExecutionWith:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrentDuplicationExecution(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCurrentDuplicationExecutionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var id = 789;  // Long | Project id

            try
            {
                // Get current duplication execution id
                'String' result = apiInstance.getCurrentDuplicationExecution(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getCurrentDuplicationExecution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$id = 789; // Long | Project id

try {
    $result = $api_instance->getCurrentDuplicationExecution($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getCurrentDuplicationExecution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $id = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCurrentDuplicationExecution(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getCurrentDuplicationExecution: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
id = 789 # Long | Project id

try: 
    # Get current duplication execution id
    api_response = api_instance.get_current_duplication_execution(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getCurrentDuplicationExecution: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getCurrentExportExecution

Get current export execution id


/service/projects/{id}/current_export_execution_id

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/projects/{id}/current_export_execution_id"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        Long id = 789; // Long | Project id
        try {
            'String' result = apiInstance.getCurrentExportExecution(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getCurrentExportExecution");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        Long id = 789; // Long | Project id
        try {
            'String' result = apiInstance.getCurrentExportExecution(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getCurrentExportExecution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get current export execution id
[apiInstance getCurrentExportExecutionWith:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrentExportExecution(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCurrentExportExecutionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var id = 789;  // Long | Project id

            try
            {
                // Get current export execution id
                'String' result = apiInstance.getCurrentExportExecution(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getCurrentExportExecution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$id = 789; // Long | Project id

try {
    $result = $api_instance->getCurrentExportExecution($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getCurrentExportExecution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $id = 789; # Long | Project id

eval { 
    my $result = $api_instance->getCurrentExportExecution(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getCurrentExportExecution: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
id = 789 # Long | Project id

try: 
    # Get current export execution id
    api_response = api_instance.get_current_export_execution(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getCurrentExportExecution: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDuplicationExecution

Get duplication execution


/service/projects/{id}/duplicate/{executionId}/status

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/duplicate/{executionId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            ExecutionData result = apiInstance.getDuplicationExecution(executionId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getDuplicationExecution");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            ExecutionData result = apiInstance.getDuplicationExecution(executionId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getDuplicationExecution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // Execution id
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get duplication execution
[apiInstance getDuplicationExecutionWith:executionId
    id:id
              completionHandler: ^(ExecutionData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} Execution id
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDuplicationExecution(executionId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDuplicationExecutionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | Execution id
            var id = 789;  // Long | Project id

            try
            {
                // Get duplication execution
                ExecutionData result = apiInstance.getDuplicationExecution(executionId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getDuplicationExecution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | Execution id
$id = 789; // Long | Project id

try {
    $result = $api_instance->getDuplicationExecution($executionId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getDuplicationExecution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | Execution id
my $id = 789; # Long | Project id

eval { 
    my $result = $api_instance->getDuplicationExecution(executionId => $executionId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getDuplicationExecution: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | Execution id
id = 789 # Long | Project id

try: 
    # Get duplication execution
    api_response = api_instance.get_duplication_execution(executionId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getDuplicationExecution: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
Execution id
Required
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDuplicationExecutionHistory

Get duplication execution history


/service/projects/duplicate_history

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/duplicate_history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            array[ProjectDuplicationExecution] result = apiInstance.getDuplicationExecutionHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getDuplicationExecutionHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            array[ProjectDuplicationExecution] result = apiInstance.getDuplicationExecutionHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getDuplicationExecutionHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get duplication execution history
[apiInstance getDuplicationExecutionHistoryWithCompletionHandler: 
              ^(array[ProjectDuplicationExecution] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDuplicationExecutionHistory(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDuplicationExecutionHistoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();

            try
            {
                // Get duplication execution history
                array[ProjectDuplicationExecution] result = apiInstance.getDuplicationExecutionHistory();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getDuplicationExecutionHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();

try {
    $result = $api_instance->getDuplicationExecutionHistory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getDuplicationExecutionHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();

eval { 
    my $result = $api_instance->getDuplicationExecutionHistory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getDuplicationExecutionHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()

try: 
    # Get duplication execution history
    api_response = api_instance.get_duplication_execution_history()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getDuplicationExecutionHistory: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExportExecution

Get export execution


/service/projects/{id}/export/{executionId}/status

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/export/{executionId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            ExecutionData result = apiInstance.getExportExecution(executionId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportExecution");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        Long id = 789; // Long | Project id
        try {
            ExecutionData result = apiInstance.getExportExecution(executionId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportExecution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // Execution id
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get export execution
[apiInstance getExportExecutionWith:executionId
    id:id
              completionHandler: ^(ExecutionData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} Execution id
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportExecution(executionId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportExecutionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | Execution id
            var id = 789;  // Long | Project id

            try
            {
                // Get export execution
                ExecutionData result = apiInstance.getExportExecution(executionId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getExportExecution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | Execution id
$id = 789; // Long | Project id

try {
    $result = $api_instance->getExportExecution($executionId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getExportExecution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | Execution id
my $id = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExportExecution(executionId => $executionId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getExportExecution: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | Execution id
id = 789 # Long | Project id

try: 
    # Get export execution
    api_response = api_instance.get_export_execution(executionId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getExportExecution: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
Execution id
Required
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExportHistory

Get export execution history


/service/projects/export_history

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/export_history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            array[ProjectExportExecution] result = apiInstance.getExportHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            array[ProjectExportExecution] result = apiInstance.getExportHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get export execution history
[apiInstance getExportHistoryWithCompletionHandler: 
              ^(array[ProjectExportExecution] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportHistory(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportHistoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();

            try
            {
                // Get export execution history
                array[ProjectExportExecution] result = apiInstance.getExportHistory();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getExportHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();

try {
    $result = $api_instance->getExportHistory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getExportHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();

eval { 
    my $result = $api_instance->getExportHistory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getExportHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()

try: 
    # Get export execution history
    api_response = api_instance.get_export_history()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getExportHistory: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExportHistoryByProject

Get export execution history for a given project


/service/projects/{id}/export_history

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/{id}/export_history?skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        LoadOptions body = ; // LoadOptions | loadingOptions
        Long id = 789; // Long | Project id
        Integer skip = 56; // Integer | skip
        Integer take = 56; // Integer | take
        try {
            array[ProjectExportExecution] result = apiInstance.getExportHistoryByProject(body, id, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportHistoryByProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        LoadOptions body = ; // LoadOptions | loadingOptions
        Long id = 789; // Long | Project id
        Integer skip = 56; // Integer | skip
        Integer take = 56; // Integer | take
        try {
            array[ProjectExportExecution] result = apiInstance.getExportHistoryByProject(body, id, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportHistoryByProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
LoadOptions *body = ; // loadingOptions
Long *id = 789; // Project id
Integer *skip = 56; // skip (optional)
Integer *take = 56; // take (optional)

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get export execution history for a given project
[apiInstance getExportHistoryByProjectWith:body
    id:id
    skip:skip
    take:take
              completionHandler: ^(array[ProjectExportExecution] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var body = ; // {{LoadOptions}} loadingOptions
var id = 789; // {{Long}} Project id
var opts = { 
  'skip': 56 // {{Integer}} skip
  'take': 56 // {{Integer}} take
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportHistoryByProject(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportHistoryByProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var body = new LoadOptions(); // LoadOptions | loadingOptions
            var id = 789;  // Long | Project id
            var skip = 56;  // Integer | skip (optional) 
            var take = 56;  // Integer | take (optional) 

            try
            {
                // Get export execution history for a given project
                array[ProjectExportExecution] result = apiInstance.getExportHistoryByProject(body, id, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getExportHistoryByProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$body = ; // LoadOptions | loadingOptions
$id = 789; // Long | Project id
$skip = 56; // Integer | skip
$take = 56; // Integer | take

try {
    $result = $api_instance->getExportHistoryByProject($body, $id, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getExportHistoryByProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $body = WWW::SwaggerClient::Object::LoadOptions->new(); # LoadOptions | loadingOptions
my $id = 789; # Long | Project id
my $skip = 56; # Integer | skip
my $take = 56; # Integer | take

eval { 
    my $result = $api_instance->getExportHistoryByProject(body => $body, id => $id, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getExportHistoryByProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
body =  # LoadOptions | loadingOptions
id = 789 # Long | Project id
skip = 56 # Integer | skip (optional)
take = 56 # Integer | take (optional)

try: 
    # Get export execution history for a given project
    api_response = api_instance.get_export_history_by_project(body, id, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getExportHistoryByProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
skip
Integer (int32)
skip
take
Integer (int32)
take

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExportHistoryByProjectCount

Get export execution history count for a given project


/service/projects/{id}/export_history/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/export_history/count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        Long id = 789; // Long | Project id
        try {
            Long result = apiInstance.getExportHistoryByProjectCount(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportHistoryByProjectCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        Long id = 789; // Long | Project id
        try {
            Long result = apiInstance.getExportHistoryByProjectCount(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getExportHistoryByProjectCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Project id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get export execution history count for a given project
[apiInstance getExportHistoryByProjectCountWith:id
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var id = 789; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportHistoryByProjectCount(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportHistoryByProjectCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var id = 789;  // Long | Project id

            try
            {
                // Get export execution history count for a given project
                Long result = apiInstance.getExportHistoryByProjectCount(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getExportHistoryByProjectCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$id = 789; // Long | Project id

try {
    $result = $api_instance->getExportHistoryByProjectCount($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getExportHistoryByProjectCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $id = 789; # Long | Project id

eval { 
    my $result = $api_instance->getExportHistoryByProjectCount(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getExportHistoryByProjectCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
id = 789 # Long | Project id

try: 
    # Get export execution history count for a given project
    api_response = api_instance.get_export_history_by_project_count(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getExportHistoryByProjectCount: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getImportExecution

Get import execution


/service/projects/import/{executionId}/status

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/import/{executionId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        try {
            ExecutionData result = apiInstance.getImportExecution(executionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getImportExecution");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String executionId = executionId_example; // String | Execution id
        try {
            ExecutionData result = apiInstance.getImportExecution(executionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getImportExecution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *executionId = executionId_example; // Execution id

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get import execution
[apiInstance getImportExecutionWith:executionId
              completionHandler: ^(ExecutionData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var executionId = executionId_example; // {{String}} Execution id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImportExecution(executionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImportExecutionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var executionId = executionId_example;  // String | Execution id

            try
            {
                // Get import execution
                ExecutionData result = apiInstance.getImportExecution(executionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getImportExecution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$executionId = executionId_example; // String | Execution id

try {
    $result = $api_instance->getImportExecution($executionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getImportExecution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $executionId = executionId_example; # String | Execution id

eval { 
    my $result = $api_instance->getImportExecution(executionId => $executionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getImportExecution: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
executionId = executionId_example # String | Execution id

try: 
    # Get import execution
    api_response = api_instance.get_import_execution(executionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getImportExecution: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
String
Execution id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getImportHistory

Get export execution history


/service/projects/import_history

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/import_history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            array[ProjectImportExecution] result = apiInstance.getImportHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getImportHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            array[ProjectImportExecution] result = apiInstance.getImportHistory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getImportHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Get export execution history
[apiInstance getImportHistoryWithCompletionHandler: 
              ^(array[ProjectImportExecution] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImportHistory(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImportHistoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();

            try
            {
                // Get export execution history
                array[ProjectImportExecution] result = apiInstance.getImportHistory();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getImportHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();

try {
    $result = $api_instance->getImportHistory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getImportHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();

eval { 
    my $result = $api_instance->getImportHistory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getImportHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()

try: 
    # Get export execution history
    api_response = api_instance.get_import_history()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getImportHistory: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMandatoryDuplicationUserAgreements

get Mandatory User Agreements for project Duplication


/service/user_agreements/project_duplication

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/user_agreements/project_duplication?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            map['String', 'String'] result = apiInstance.getMandatoryDuplicationUserAgreements(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getMandatoryDuplicationUserAgreements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            map['String', 'String'] result = apiInstance.getMandatoryDuplicationUserAgreements(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getMandatoryDuplicationUserAgreements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// get Mandatory User Agreements for project Duplication
[apiInstance getMandatoryDuplicationUserAgreementsWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMandatoryDuplicationUserAgreements(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMandatoryDuplicationUserAgreementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // get Mandatory User Agreements for project Duplication
                map['String', 'String'] result = apiInstance.getMandatoryDuplicationUserAgreements(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getMandatoryDuplicationUserAgreements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getMandatoryDuplicationUserAgreements($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getMandatoryDuplicationUserAgreements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getMandatoryDuplicationUserAgreements(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getMandatoryDuplicationUserAgreements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # get Mandatory User Agreements for project Duplication
    api_response = api_instance.get_mandatory_duplication_user_agreements(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getMandatoryDuplicationUserAgreements: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getMandatoryExportUserAgreements

get Mandatory User Agreements for project Export


/service/user_agreements/project_export

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/user_agreements/project_export?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            map['String', 'String'] result = apiInstance.getMandatoryExportUserAgreements(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getMandatoryExportUserAgreements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            map['String', 'String'] result = apiInstance.getMandatoryExportUserAgreements(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#getMandatoryExportUserAgreements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// get Mandatory User Agreements for project Export
[apiInstance getMandatoryExportUserAgreementsWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMandatoryExportUserAgreements(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMandatoryExportUserAgreementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // get Mandatory User Agreements for project Export
                map['String', 'String'] result = apiInstance.getMandatoryExportUserAgreements(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.getMandatoryExportUserAgreements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getMandatoryExportUserAgreements($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->getMandatoryExportUserAgreements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getMandatoryExportUserAgreements(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->getMandatoryExportUserAgreements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # get Mandatory User Agreements for project Export
    api_response = api_instance.get_mandatory_export_user_agreements(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->getMandatoryExportUserAgreements: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleImportProjectZip

Upload zip file for project import


/service/projects/import/upload

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/projects/import/upload"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            ProjectFileAnalyseResponse result = apiInstance.handleImportProjectZip();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#handleImportProjectZip");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            ProjectFileAnalyseResponse result = apiInstance.handleImportProjectZip();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#handleImportProjectZip");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Upload zip file for project import
[apiInstance handleImportProjectZipWithCompletionHandler: 
              ^(ProjectFileAnalyseResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleImportProjectZip(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleImportProjectZipExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();

            try
            {
                // Upload zip file for project import
                ProjectFileAnalyseResponse result = apiInstance.handleImportProjectZip();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.handleImportProjectZip: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();

try {
    $result = $api_instance->handleImportProjectZip();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->handleImportProjectZip: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();

eval { 
    my $result = $api_instance->handleImportProjectZip();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->handleImportProjectZip: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()

try: 
    # Upload zip file for project import
    api_response = api_instance.handle_import_project_zip()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->handleImportProjectZip: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


importProject

Import project


/service/projects/import

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/text"\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/import"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        ProjectFileImportOptions body = ; // ProjectFileImportOptions | Import options
        try {
            'String' result = apiInstance.importProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#importProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        ProjectFileImportOptions body = ; // ProjectFileImportOptions | Import options
        try {
            'String' result = apiInstance.importProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#importProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ProjectFileImportOptions *body = ; // Import options

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Import project
[apiInstance importProjectWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var body = ; // {{ProjectFileImportOptions}} Import options

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class importProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();
            var body = new ProjectFileImportOptions(); // ProjectFileImportOptions | Import options

            try
            {
                // Import project
                'String' result = apiInstance.importProject(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.importProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();
$body = ; // ProjectFileImportOptions | Import options

try {
    $result = $api_instance->importProject($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->importProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();
my $body = WWW::SwaggerClient::Object::ProjectFileImportOptions->new(); # ProjectFileImportOptions | Import options

eval { 
    my $result = $api_instance->importProject(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->importProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()
body =  # ProjectFileImportOptions | Import options

try: 
    # Import project
    api_response = api_instance.import_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->importProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


isAnyExecutionRunning

Check if there is any running project operation (import/export/duplicate)


/service/projects/execution/running

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/execution/running"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

import java.io.File;
import java.util.*;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            'Boolean' result = apiInstance.isAnyExecutionRunning();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#isAnyExecutionRunning");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectBulkExecutionControllerApi;

public class ProjectBulkExecutionControllerApiExample {

    public static void main(String[] args) {
        ProjectBulkExecutionControllerApi apiInstance = new ProjectBulkExecutionControllerApi();
        try {
            'Boolean' result = apiInstance.isAnyExecutionRunning();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectBulkExecutionControllerApi#isAnyExecutionRunning");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectBulkExecutionControllerApi *apiInstance = [[ProjectBulkExecutionControllerApi alloc] init];

// Check if there is any running project operation (import/export/duplicate)
[apiInstance isAnyExecutionRunningWithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectBulkExecutionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isAnyExecutionRunning(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isAnyExecutionRunningExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectBulkExecutionControllerApi();

            try
            {
                // Check if there is any running project operation (import/export/duplicate)
                'Boolean' result = apiInstance.isAnyExecutionRunning();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectBulkExecutionControllerApi.isAnyExecutionRunning: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectBulkExecutionControllerApi();

try {
    $result = $api_instance->isAnyExecutionRunning();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectBulkExecutionControllerApi->isAnyExecutionRunning: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectBulkExecutionControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectBulkExecutionControllerApi->new();

eval { 
    my $result = $api_instance->isAnyExecutionRunning();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectBulkExecutionControllerApi->isAnyExecutionRunning: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectBulkExecutionControllerApi()

try: 
    # Check if there is any running project operation (import/export/duplicate)
    api_response = api_instance.is_any_execution_running()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectBulkExecutionControllerApi->isAnyExecutionRunning: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ProjectController

createProject

Create a new project

Create a new project and returns the new generated Id


/service/projects

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        CreateProjectEntry body = ; // CreateProjectEntry | New project data
        try {
            Long result = apiInstance.createProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#createProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        CreateProjectEntry body = ; // CreateProjectEntry | New project data
        try {
            Long result = apiInstance.createProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#createProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateProjectEntry *body = ; // New project data

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Create a new project
[apiInstance createProjectWith:body
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var body = ; // {{CreateProjectEntry}} New project data

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var body = new CreateProjectEntry(); // CreateProjectEntry | New project data

            try
            {
                // Create a new project
                Long result = apiInstance.createProject(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$body = ; // CreateProjectEntry | New project data

try {
    $result = $api_instance->createProject($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->createProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateProjectEntry->new(); # CreateProjectEntry | New project data

eval { 
    my $result = $api_instance->createProject(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->createProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
body =  # CreateProjectEntry | New project data

try: 
    # Create a new project
    api_response = api_instance.create_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->createProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteProject

Delete an existing project

Delete an existing project


/service/projects/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/projects/{id}?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        String token = token_example; // String | token
        try {
            apiInstance.deleteProject(id, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        String token = token_example; // String | token
        try {
            apiInstance.deleteProject(id, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#deleteProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id
String *token = token_example; // token

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Delete an existing project
[apiInstance deleteProjectWith:id
    token:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id
var token = token_example; // {{String}} token

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(id, token, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id
            var token = token_example;  // String | token

            try
            {
                // Delete an existing project
                apiInstance.deleteProject(id, token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id
$token = token_example; // String | token

try {
    $api_instance->deleteProject($id, $token);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id
my $token = token_example; # String | token

eval { 
    $api_instance->deleteProject(id => $id, token => $token);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id
token = token_example # String | token

try: 
    # Delete an existing project
    api_instance.delete_project(id, token)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->deleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required
Query parameters
Name Description
token*
String
token
Required

Responses

Status: 200 - OK


getAllProjects

Get a list of the available projects


/service/projects

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        try {
            array[Project] result = apiInstance.getAllProjects();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getAllProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        try {
            array[Project] result = apiInstance.getAllProjects();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getAllProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Get a list of the available projects
[apiInstance getAllProjectsWithCompletionHandler: 
              ^(array[Project] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllProjects(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllProjectsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();

            try
            {
                // Get a list of the available projects
                array[Project] result = apiInstance.getAllProjects();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.getAllProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();

try {
    $result = $api_instance->getAllProjects();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->getAllProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();

eval { 
    my $result = $api_instance->getAllProjects();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->getAllProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()

try: 
    # Get a list of the available projects
    api_response = api_instance.get_all_projects()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->getAllProjects: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDefaultProject

Get the default project

Get the default project


/service/projects/member/default

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/member/default"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        try {
            Project result = apiInstance.getDefaultProject();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getDefaultProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        try {
            Project result = apiInstance.getDefaultProject();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getDefaultProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Get the default project
[apiInstance getDefaultProjectWithCompletionHandler: 
              ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefaultProject(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDefaultProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();

            try
            {
                // Get the default project
                Project result = apiInstance.getDefaultProject();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.getDefaultProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();

try {
    $result = $api_instance->getDefaultProject();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->getDefaultProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();

eval { 
    my $result = $api_instance->getDefaultProject();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->getDefaultProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()

try: 
    # Get the default project
    api_response = api_instance.get_default_project()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->getDefaultProject: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getDeleteProjectVerificationCode

Get project delete request code


/service/projects/{id}/verification

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/verification?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.getDeleteProjectVerificationCode(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getDeleteProjectVerificationCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.getDeleteProjectVerificationCode(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getDeleteProjectVerificationCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Get project delete request code
[apiInstance getDeleteProjectVerificationCodeWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDeleteProjectVerificationCode(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDeleteProjectVerificationCodeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get project delete request code
                apiInstance.getDeleteProjectVerificationCode(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.getDeleteProjectVerificationCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->getDeleteProjectVerificationCode($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->getDeleteProjectVerificationCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->getDeleteProjectVerificationCode(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->getDeleteProjectVerificationCode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get project delete request code
    api_instance.get_delete_project_verification_code(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->getDeleteProjectVerificationCode: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getProject

Get a project by Id


/service/projects/{id}/data

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            ProjectData result = apiInstance.getProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            ProjectData result = apiInstance.getProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Get a project by Id
[apiInstance getProjectWith:id
              completionHandler: ^(ProjectData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id

            try
            {
                // Get a project by Id
                ProjectData result = apiInstance.getProject(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id

try {
    $result = $api_instance->getProject($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->getProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id

eval { 
    my $result = $api_instance->getProject(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->getProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id

try: 
    # Get a project by Id
    api_response = api_instance.get_project(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->getProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getProjectElements

Get project elements


/service/projects/{id}/elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/elements"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            DCProjectElements result = apiInstance.getProjectElements(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getProjectElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            DCProjectElements result = apiInstance.getProjectElements(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getProjectElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Get project elements
[apiInstance getProjectElementsWith:id
              completionHandler: ^(DCProjectElements output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectElements(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id

            try
            {
                // Get project elements
                DCProjectElements result = apiInstance.getProjectElements(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.getProjectElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id

try {
    $result = $api_instance->getProjectElements($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->getProjectElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id

eval { 
    my $result = $api_instance->getProjectElements(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->getProjectElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id

try: 
    # Get project elements
    api_response = api_instance.get_project_elements(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->getProjectElements: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getProjectUsingGET

Get a project by Id


/service/projects/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            Project result = apiInstance.getProjectUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getProjectUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            Project result = apiInstance.getProjectUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#getProjectUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Get a project by Id
[apiInstance getProjectUsingGETWith:id
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectUsingGET(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id

            try
            {
                // Get a project by Id
                Project result = apiInstance.getProjectUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.getProjectUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id

try {
    $result = $api_instance->getProjectUsingGET($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->getProjectUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id

eval { 
    my $result = $api_instance->getProjectUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->getProjectUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id

try: 
    # Get a project by Id
    api_response = api_instance.get_project_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->getProjectUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


isPublicUsingGET

Check if the project is public


/service/projects/{id}/is_public

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/is_public"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            'Boolean' result = apiInstance.isPublicUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#isPublicUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            'Boolean' result = apiInstance.isPublicUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#isPublicUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Check if the project is public
[apiInstance isPublicUsingGETWith:id
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isPublicUsingGET(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isPublicUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id

            try
            {
                // Check if the project is public
                'Boolean' result = apiInstance.isPublicUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.isPublicUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id

try {
    $result = $api_instance->isPublicUsingGET($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->isPublicUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id

eval { 
    my $result = $api_instance->isPublicUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->isPublicUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id

try: 
    # Check if the project is public
    api_response = api_instance.is_public_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->isPublicUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


setDefaultProject

Set the default project

Set the default project


/service/projects/member/default

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/member/default"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long body = ; // Long | Project id
        try {
            apiInstance.setDefaultProject(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#setDefaultProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long body = ; // Long | Project id
        try {
            apiInstance.setDefaultProject(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#setDefaultProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *body = ; // Project id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Set the default project
[apiInstance setDefaultProjectWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var body = ; // {{Long}} Project id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setDefaultProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setDefaultProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var body = new Long(); // Long | Project id

            try
            {
                // Set the default project
                apiInstance.setDefaultProject(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.setDefaultProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$body = ; // Long | Project id

try {
    $api_instance->setDefaultProject($body);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->setDefaultProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | Project id

eval { 
    $api_instance->setDefaultProject(body => $body);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->setDefaultProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
body =  # Long | Project id

try: 
    # Set the default project
    api_instance.set_default_project(body)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->setDefaultProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


setFavoriteProject

Set the favorite project

Set the favorite project


/service/projects/{id}/member/favorite

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/{id}/member/favorite"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Boolean body = ; // Boolean | Favorite
        Long id = 789; // Long | Requested project Id
        try {
            apiInstance.setFavoriteProject(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#setFavoriteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Boolean body = ; // Boolean | Favorite
        Long id = 789; // Long | Requested project Id
        try {
            apiInstance.setFavoriteProject(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#setFavoriteProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *body = ; // Favorite
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Set the favorite project
[apiInstance setFavoriteProjectWith:body
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var body = ; // {{Boolean}} Favorite
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setFavoriteProject(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setFavoriteProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var body = new Boolean(); // Boolean | Favorite
            var id = 789;  // Long | Requested project Id

            try
            {
                // Set the favorite project
                apiInstance.setFavoriteProject(body, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.setFavoriteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$body = ; // Boolean | Favorite
$id = 789; // Long | Requested project Id

try {
    $api_instance->setFavoriteProject($body, $id);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->setFavoriteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $body = WWW::SwaggerClient::Object::Boolean->new(); # Boolean | Favorite
my $id = 789; # Long | Requested project Id

eval { 
    $api_instance->setFavoriteProject(body => $body, id => $id);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->setFavoriteProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
body =  # Boolean | Favorite
id = 789 # Long | Requested project Id

try: 
    # Set the favorite project
    api_instance.set_favorite_project(body, id)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->setFavoriteProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


updateProject

Edit an existing project

Edit an existing project


/service/projects/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        UpdateProjectEntry body = ; // UpdateProjectEntry | New project data
        Long id = 789; // Long | Requested project Id
        try {
            apiInstance.updateProject(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#updateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        UpdateProjectEntry body = ; // UpdateProjectEntry | New project data
        Long id = 789; // Long | Requested project Id
        try {
            apiInstance.updateProject(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#updateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateProjectEntry *body = ; // New project data
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Edit an existing project
[apiInstance updateProjectWith:body
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var body = ; // {{UpdateProjectEntry}} New project data
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProject(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var body = new UpdateProjectEntry(); // UpdateProjectEntry | New project data
            var id = 789;  // Long | Requested project Id

            try
            {
                // Edit an existing project
                apiInstance.updateProject(body, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$body = ; // UpdateProjectEntry | New project data
$id = 789; // Long | Requested project Id

try {
    $api_instance->updateProject($body, $id);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateProjectEntry->new(); # UpdateProjectEntry | New project data
my $id = 789; # Long | Requested project Id

eval { 
    $api_instance->updateProject(body => $body, id => $id);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
body =  # UpdateProjectEntry | New project data
id = 789 # Long | Requested project Id

try: 
    # Edit an existing project
    api_instance.update_project(body, id)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->updateProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


usedByOtherProjectInOtherProject

Check if the project elements are used in other projects


/service/projects/{id}/used_in_project

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/used_in_project"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            'Boolean' result = apiInstance.usedByOtherProjectInOtherProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#usedByOtherProjectInOtherProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            'Boolean' result = apiInstance.usedByOtherProjectInOtherProject(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#usedByOtherProjectInOtherProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Check if the project elements are used in other projects
[apiInstance usedByOtherProjectInOtherProjectWith:id
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usedByOtherProjectInOtherProject(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class usedByOtherProjectInOtherProjectExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id

            try
            {
                // Check if the project elements are used in other projects
                'Boolean' result = apiInstance.usedByOtherProjectInOtherProject(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.usedByOtherProjectInOtherProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id

try {
    $result = $api_instance->usedByOtherProjectInOtherProject($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->usedByOtherProjectInOtherProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id

eval { 
    my $result = $api_instance->usedByOtherProjectInOtherProject(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->usedByOtherProjectInOtherProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id

try: 
    # Check if the project elements are used in other projects
    api_response = api_instance.used_by_other_project_in_other_project(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->usedByOtherProjectInOtherProject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


usesPublicElements

Check if the project uses public elements


/service/projects/{id}/uses_public_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/projects/{id}/uses_public_elements"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectControllerApi;

import java.io.File;
import java.util.*;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            'Boolean' result = apiInstance.usesPublicElements(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#usesPublicElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectControllerApi;

public class ProjectControllerApiExample {

    public static void main(String[] args) {
        ProjectControllerApi apiInstance = new ProjectControllerApi();
        Long id = 789; // Long | Requested project Id
        try {
            'Boolean' result = apiInstance.usesPublicElements(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectControllerApi#usesPublicElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested project Id

ProjectControllerApi *apiInstance = [[ProjectControllerApi alloc] init];

// Check if the project uses public elements
[apiInstance usesPublicElementsWith:id
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectControllerApi()
var id = 789; // {{Long}} Requested project Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usesPublicElements(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class usesPublicElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectControllerApi();
            var id = 789;  // Long | Requested project Id

            try
            {
                // Check if the project uses public elements
                'Boolean' result = apiInstance.usesPublicElements(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectControllerApi.usesPublicElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectControllerApi();
$id = 789; // Long | Requested project Id

try {
    $result = $api_instance->usesPublicElements($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectControllerApi->usesPublicElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectControllerApi->new();
my $id = 789; # Long | Requested project Id

eval { 
    my $result = $api_instance->usesPublicElements(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectControllerApi->usesPublicElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectControllerApi()
id = 789 # Long | Requested project Id

try: 
    # Check if the project uses public elements
    api_response = api_instance.uses_public_elements(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectControllerApi->usesPublicElements: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested project Id
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ProjectMessageController

sendMessageToUser

Send message to user


/service/projects/{id}/messages

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/projects/{id}/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectMessageControllerApi;

import java.io.File;
import java.util.*;

public class ProjectMessageControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ProjectMessageControllerApi apiInstance = new ProjectMessageControllerApi();
        Message body = ; // Message | message
        Long id = 789; // Long | Project id
        String acceptLanguage = acceptLanguage_example; // String | accept-language
        try {
            apiInstance.sendMessageToUser(body, id, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectMessageControllerApi#sendMessageToUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectMessageControllerApi;

public class ProjectMessageControllerApiExample {

    public static void main(String[] args) {
        ProjectMessageControllerApi apiInstance = new ProjectMessageControllerApi();
        Message body = ; // Message | message
        Long id = 789; // Long | Project id
        String acceptLanguage = acceptLanguage_example; // String | accept-language
        try {
            apiInstance.sendMessageToUser(body, id, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectMessageControllerApi#sendMessageToUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Message *body = ; // message
Long *id = 789; // Project id
String *acceptLanguage = acceptLanguage_example; // accept-language (optional)

ProjectMessageControllerApi *apiInstance = [[ProjectMessageControllerApi alloc] init];

// Send message to user
[apiInstance sendMessageToUserWith:body
    id:id
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ProjectMessageControllerApi()
var body = ; // {{Message}} message
var id = 789; // {{Long}} Project id
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} accept-language
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendMessageToUser(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sendMessageToUserExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectMessageControllerApi();
            var body = new Message(); // Message | message
            var id = 789;  // Long | Project id
            var acceptLanguage = acceptLanguage_example;  // String | accept-language (optional) 

            try
            {
                // Send message to user
                apiInstance.sendMessageToUser(body, id, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectMessageControllerApi.sendMessageToUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectMessageControllerApi();
$body = ; // Message | message
$id = 789; // Long | Project id
$acceptLanguage = acceptLanguage_example; // String | accept-language

try {
    $api_instance->sendMessageToUser($body, $id, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling ProjectMessageControllerApi->sendMessageToUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectMessageControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectMessageControllerApi->new();
my $body = WWW::SwaggerClient::Object::Message->new(); # Message | message
my $id = 789; # Long | Project id
my $acceptLanguage = acceptLanguage_example; # String | accept-language

eval { 
    $api_instance->sendMessageToUser(body => $body, id => $id, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling ProjectMessageControllerApi->sendMessageToUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectMessageControllerApi()
body =  # Message | message
id = 789 # Long | Project id
acceptLanguage = acceptLanguage_example # String | accept-language (optional)

try: 
    # Send message to user
    api_instance.send_message_to_user(body, id, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling ProjectMessageControllerApi->sendMessageToUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Project id
Required
Header parameters
Name Description
accept-language
String
accept-language
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


RangeChartController

checkConfigUsingGET11

Check the configuration informations of an existing chart


/service/charts/range/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/range/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET11(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#checkConfigUsingGET11");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET11(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#checkConfigUsingGET11");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET11With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET11(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET11Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET11(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.checkConfigUsingGET11: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET11($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->checkConfigUsingGET11: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET11(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->checkConfigUsingGET11: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get11(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->checkConfigUsingGET11: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createRangeChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/range

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/range?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createRangeChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#createRangeChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createRangeChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#createRangeChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Create a new chart
[apiInstance createRangeChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRangeChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRangeChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createRangeChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.createRangeChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createRangeChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->createRangeChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createRangeChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->createRangeChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_range_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->createRangeChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createRangeChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/range/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/range/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createRangeChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#createRangeChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createRangeChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#createRangeChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createRangeChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRangeChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRangeChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createRangeChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.createRangeChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createRangeChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->createRangeChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createRangeChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->createRangeChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_range_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->createRangeChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteRangeChart

Delete an existing chart


/service/charts/range/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/range/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteRangeChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#deleteRangeChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteRangeChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#deleteRangeChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteRangeChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRangeChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRangeChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteRangeChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.deleteRangeChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteRangeChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->deleteRangeChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteRangeChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->deleteRangeChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_range_chart(id, project=project)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->deleteRangeChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateRangeChart

Duplicate an existing chart


/service/charts/range/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/range/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateRangeChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#duplicateRangeChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateRangeChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#duplicateRangeChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateRangeChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateRangeChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateRangeChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateRangeChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.duplicateRangeChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateRangeChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->duplicateRangeChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateRangeChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->duplicateRangeChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_range_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->duplicateRangeChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editRangeChart

Edit chart

Edit an existing chart


/service/charts/range/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/range/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editRangeChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#editRangeChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editRangeChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#editRangeChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Edit chart
[apiInstance editRangeChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editRangeChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editRangeChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editRangeChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.editRangeChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editRangeChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->editRangeChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editRangeChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->editRangeChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_range_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->editRangeChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editRangeChartConfig

Update the configuration informations of an existing chart


/service/charts/range/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/range/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        UpdateRangeChartConfigEntry body = ; // UpdateRangeChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editRangeChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#editRangeChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        UpdateRangeChartConfigEntry body = ; // UpdateRangeChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editRangeChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#editRangeChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateRangeChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editRangeChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var body = ; // {{UpdateRangeChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editRangeChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editRangeChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var body = new UpdateRangeChartConfigEntry(); // UpdateRangeChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editRangeChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.editRangeChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$body = ; // UpdateRangeChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editRangeChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->editRangeChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRangeChartConfigEntry->new(); # UpdateRangeChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editRangeChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->editRangeChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
body =  # UpdateRangeChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_range_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->editRangeChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getRangeChart

Get a chart by Id


/service/charts/range/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/range/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getRangeChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#getRangeChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getRangeChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#getRangeChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getRangeChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRangeChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRangeChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getRangeChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.getRangeChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getRangeChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->getRangeChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getRangeChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->getRangeChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_range_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->getRangeChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getRangeChartConfig

Get the configuration informations of an existing chart


/service/charts/range/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/range/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RangeChartControllerApi;

import java.io.File;
import java.util.*;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            RangeChartConfig result = apiInstance.getRangeChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#getRangeChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RangeChartControllerApi;

public class RangeChartControllerApiExample {

    public static void main(String[] args) {
        RangeChartControllerApi apiInstance = new RangeChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            RangeChartConfig result = apiInstance.getRangeChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RangeChartControllerApi#getRangeChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

RangeChartControllerApi *apiInstance = [[RangeChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getRangeChartConfigWith:id
    project:project
              completionHandler: ^(RangeChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.RangeChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRangeChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRangeChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RangeChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                RangeChartConfig result = apiInstance.getRangeChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RangeChartControllerApi.getRangeChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRangeChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getRangeChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RangeChartControllerApi->getRangeChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RangeChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RangeChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getRangeChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RangeChartControllerApi->getRangeChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RangeChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_range_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RangeChartControllerApi->getRangeChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


S3ConnectorController

checkS3Connection

Check a S3 connector connectivity


/service/connectors/s3/check_connection

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/s3/check_connection?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkS3Connection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#checkS3Connection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkS3Connection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#checkS3Connection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
S3Connector *body = ; // s3Connector
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// Check a S3 connector connectivity
[apiInstance checkS3ConnectionWith:body
    ctx:ctx
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var body = ; // {{S3Connector}} s3Connector
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkS3Connection(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkS3ConnectionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var body = new S3Connector(); // S3Connector | s3Connector
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check a S3 connector connectivity
                'Boolean' result = apiInstance.checkS3Connection(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.checkS3Connection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$body = ; // S3Connector | s3Connector
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkS3Connection($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->checkS3Connection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::S3Connector->new(); # S3Connector | s3Connector
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkS3Connection(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->checkS3Connection: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
body =  # S3Connector | s3Connector
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Check a S3 connector connectivity
    api_response = api_instance.check_s3_connection(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->checkS3Connection: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createS3Connector

Create a new S3 connector

Create a new S3 connector and return the created object


/service/connectors/s3

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/s3?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Long project = 789; // Long | Project id
        try {
            S3Connector result = apiInstance.createS3Connector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#createS3Connector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Long project = 789; // Long | Project id
        try {
            S3Connector result = apiInstance.createS3Connector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#createS3Connector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
S3Connector *body = ; // s3Connector
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// Create a new S3 connector
[apiInstance createS3ConnectorWith:body
    project:project
              completionHandler: ^(S3Connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var body = ; // {{S3Connector}} s3Connector
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createS3Connector(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createS3ConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var body = new S3Connector(); // S3Connector | s3Connector
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new S3 connector
                S3Connector result = apiInstance.createS3Connector(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.createS3Connector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$body = ; // S3Connector | s3Connector
$project = 789; // Long | Project id

try {
    $result = $api_instance->createS3Connector($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->createS3Connector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::S3Connector->new(); # S3Connector | s3Connector
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createS3Connector(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->createS3Connector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
body =  # S3Connector | s3Connector
project = 789 # Long | Project id (optional)

try: 
    # Create a new S3 connector
    api_response = api_instance.create_s3_connector(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->createS3Connector: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteS3Connector

Delete a S3 connector

Delete an existing S3 connector for a given ID and return the delete object ID


/service/connectors/s3/{connectorId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/connectors/s3/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteS3Connector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#deleteS3Connector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteS3Connector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#deleteS3Connector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// Delete a S3 connector
[apiInstance deleteS3ConnectorWith:connectorId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteS3Connector(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteS3ConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a S3 connector
                apiInstance.deleteS3Connector(connectorId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.deleteS3Connector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $api_instance->deleteS3Connector($connectorId, $project);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->deleteS3Connector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteS3Connector(connectorId => $connectorId, project => $project);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->deleteS3Connector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Delete a S3 connector
    api_instance.delete_s3_connector(connectorId, project=project)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->deleteS3Connector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editS3Connector

Edit a S3 connector

Edit an existing S3 connector and return the updated object


/service/connectors/s3/{connectorId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/s3/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            S3Connector result = apiInstance.editS3Connector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#editS3Connector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            S3Connector result = apiInstance.editS3Connector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#editS3Connector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
S3Connector *body = ; // s3Connector
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// Edit a S3 connector
[apiInstance editS3ConnectorWith:body
    connectorId:connectorId
    project:project
              completionHandler: ^(S3Connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var body = ; // {{S3Connector}} s3Connector
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editS3Connector(bodyconnectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editS3ConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var body = new S3Connector(); // S3Connector | s3Connector
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a S3 connector
                S3Connector result = apiInstance.editS3Connector(body, connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.editS3Connector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$body = ; // S3Connector | s3Connector
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editS3Connector($body, $connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->editS3Connector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::S3Connector->new(); # S3Connector | s3Connector
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editS3Connector(body => $body, connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->editS3Connector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
body =  # S3Connector | s3Connector
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Edit a S3 connector
    api_response = api_instance.edit_s3_connector(body, connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->editS3Connector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllS3Connectors

View a list of S3 connectors


/service/connectors/s3

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/s3?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[S3Connector] result = apiInstance.findAllS3Connectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#findAllS3Connectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[S3Connector] result = apiInstance.findAllS3Connectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#findAllS3Connectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// View a list of S3 connectors
[apiInstance findAllS3ConnectorsWith:project
              completionHandler: ^(array[S3Connector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllS3Connectors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllS3ConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of S3 connectors
                array[S3Connector] result = apiInstance.findAllS3Connectors(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.findAllS3Connectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllS3Connectors($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->findAllS3Connectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllS3Connectors(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->findAllS3Connectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of S3 connectors
    api_response = api_instance.find_all_s3_connectors(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->findAllS3Connectors: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneS3ConnectorById

Get a S3 connector by ID


/service/connectors/s3/{connectorId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/s3/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            S3Connector result = apiInstance.findOneS3ConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#findOneS3ConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            S3Connector result = apiInstance.findOneS3ConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#findOneS3ConnectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// Get a S3 connector by ID
[apiInstance findOneS3ConnectorByIdWith:connectorId
    project:project
              completionHandler: ^(S3Connector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneS3ConnectorById(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneS3ConnectorByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a S3 connector by ID
                S3Connector result = apiInstance.findOneS3ConnectorById(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.findOneS3ConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneS3ConnectorById($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->findOneS3ConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneS3ConnectorById(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->findOneS3ConnectorById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Get a S3 connector by ID
    api_response = api_instance.find_one_s3_connector_by_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->findOneS3ConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listS3RemoteFiles

List S3 remote files


/service/connectors/files/s3

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/files/s3?ctx=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listS3RemoteFiles(body, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#listS3RemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        S3Connector body = ; // S3Connector | s3Connector
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listS3RemoteFiles(body, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#listS3RemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
S3Connector *body = ; // s3Connector
Integer *ctx = 56; // ctx
String *remotePath = remotePath_example; // remotePath
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// List S3 remote files
[apiInstance listS3RemoteFilesWith:body
    ctx:ctx
    remotePath:remotePath
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var body = ; // {{S3Connector}} s3Connector
var ctx = 56; // {{Integer}} ctx
var remotePath = remotePath_example; // {{String}} remotePath
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listS3RemoteFiles(bodyctxremotePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listS3RemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var body = new S3Connector(); // S3Connector | s3Connector
            var ctx = 56;  // Integer | ctx
            var remotePath = remotePath_example;  // String | remotePath
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // List S3 remote files
                'Boolean' result = apiInstance.listS3RemoteFiles(body, ctx, remotePath, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.listS3RemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$body = ; // S3Connector | s3Connector
$ctx = 56; // Integer | ctx
$remotePath = remotePath_example; // String | remotePath
$project = 789; // Long | Project id

try {
    $result = $api_instance->listS3RemoteFiles($body, $ctx, $remotePath, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->listS3RemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::S3Connector->new(); # S3Connector | s3Connector
my $ctx = 56; # Integer | ctx
my $remotePath = remotePath_example; # String | remotePath
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listS3RemoteFiles(body => $body, ctx => $ctx, remotePath => $remotePath, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->listS3RemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
body =  # S3Connector | s3Connector
ctx = 56 # Integer | ctx
remotePath = remotePath_example # String | remotePath
project = 789 # Long | Project id (optional)

try: 
    # List S3 remote files
    api_response = api_instance.list_s3_remote_files(body, ctx, remotePath, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->listS3RemoteFiles: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
remotePath*
String
remotePath
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listS3RemoteFilesById

List S3 remote files by id


/service/connectors/s3/{connectorId}/files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/s3/{connectorId}/files?ctx=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.S3ConnectorControllerApi;

import java.io.File;
import java.util.*;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listS3RemoteFilesById(connectorId, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#listS3RemoteFilesById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.S3ConnectorControllerApi;

public class S3ConnectorControllerApiExample {

    public static void main(String[] args) {
        S3ConnectorControllerApi apiInstance = new S3ConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listS3RemoteFilesById(connectorId, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling S3ConnectorControllerApi#listS3RemoteFilesById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Integer *ctx = 56; // ctx
String *remotePath = remotePath_example; // remotePath
Long *project = 789; // Project id (optional)

S3ConnectorControllerApi *apiInstance = [[S3ConnectorControllerApi alloc] init];

// List S3 remote files by id
[apiInstance listS3RemoteFilesByIdWith:connectorId
    ctx:ctx
    remotePath:remotePath
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.S3ConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var ctx = 56; // {{Integer}} ctx
var remotePath = remotePath_example; // {{String}} remotePath
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listS3RemoteFilesById(connectorId, ctx, remotePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listS3RemoteFilesByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new S3ConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var ctx = 56;  // Integer | ctx
            var remotePath = remotePath_example;  // String | remotePath
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // List S3 remote files by id
                'Boolean' result = apiInstance.listS3RemoteFilesById(connectorId, ctx, remotePath, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling S3ConnectorControllerApi.listS3RemoteFilesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiS3ConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$ctx = 56; // Integer | ctx
$remotePath = remotePath_example; // String | remotePath
$project = 789; // Long | Project id

try {
    $result = $api_instance->listS3RemoteFilesById($connectorId, $ctx, $remotePath, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling S3ConnectorControllerApi->listS3RemoteFilesById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::S3ConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::S3ConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $ctx = 56; # Integer | ctx
my $remotePath = remotePath_example; # String | remotePath
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listS3RemoteFilesById(connectorId => $connectorId, ctx => $ctx, remotePath => $remotePath, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling S3ConnectorControllerApi->listS3RemoteFilesById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.S3ConnectorControllerApi()
connectorId = 789 # Long | connectorId
ctx = 56 # Integer | ctx
remotePath = remotePath_example # String | remotePath
project = 789 # Long | Project id (optional)

try: 
    # List S3 remote files by id
    api_response = api_instance.list_s3_remote_files_by_id(connectorId, ctx, remotePath, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling S3ConnectorControllerApi->listS3RemoteFilesById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
remotePath*
String
remotePath
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


SankeyChartController

checkConfigUsingGET12

Check the configuration informations of an existing chart


/service/charts/sankey/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/sankey/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET12(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#checkConfigUsingGET12");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET12(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#checkConfigUsingGET12");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET12With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET12(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET12Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET12(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.checkConfigUsingGET12: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET12($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->checkConfigUsingGET12: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET12(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->checkConfigUsingGET12: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get12(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->checkConfigUsingGET12: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createSankeyChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/sankey

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/sankey?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createSankeyChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#createSankeyChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createSankeyChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#createSankeyChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Create a new chart
[apiInstance createSankeyChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSankeyChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSankeyChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createSankeyChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.createSankeyChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createSankeyChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->createSankeyChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createSankeyChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->createSankeyChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_sankey_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->createSankeyChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createSankeyChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/sankey/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/sankey/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createSankeyChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#createSankeyChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createSankeyChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#createSankeyChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createSankeyChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSankeyChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSankeyChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createSankeyChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.createSankeyChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createSankeyChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->createSankeyChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createSankeyChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->createSankeyChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_sankey_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->createSankeyChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteSankeyChart

Delete an existing chart


/service/charts/sankey/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/sankey/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteSankeyChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#deleteSankeyChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteSankeyChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#deleteSankeyChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteSankeyChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSankeyChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteSankeyChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteSankeyChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.deleteSankeyChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteSankeyChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->deleteSankeyChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteSankeyChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->deleteSankeyChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_sankey_chart(id, project=project)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->deleteSankeyChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateSankeyChart

Duplicate an existing chart


/service/charts/sankey/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/sankey/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateSankeyChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#duplicateSankeyChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateSankeyChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#duplicateSankeyChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateSankeyChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateSankeyChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateSankeyChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateSankeyChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.duplicateSankeyChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateSankeyChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->duplicateSankeyChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateSankeyChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->duplicateSankeyChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_sankey_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->duplicateSankeyChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editSankeyChart

Edit chart

Edit an existing chart


/service/charts/sankey/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/sankey/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editSankeyChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#editSankeyChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editSankeyChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#editSankeyChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Edit chart
[apiInstance editSankeyChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editSankeyChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editSankeyChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editSankeyChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.editSankeyChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editSankeyChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->editSankeyChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editSankeyChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->editSankeyChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_sankey_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->editSankeyChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editSankeyChartConfig

Update the configuration informations of an existing chart


/service/charts/sankey/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/sankey/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        UpdateSankeyChartConfigEntry body = ; // UpdateSankeyChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editSankeyChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#editSankeyChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        UpdateSankeyChartConfigEntry body = ; // UpdateSankeyChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editSankeyChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#editSankeyChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateSankeyChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editSankeyChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var body = ; // {{UpdateSankeyChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editSankeyChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editSankeyChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var body = new UpdateSankeyChartConfigEntry(); // UpdateSankeyChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editSankeyChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.editSankeyChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$body = ; // UpdateSankeyChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editSankeyChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->editSankeyChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateSankeyChartConfigEntry->new(); # UpdateSankeyChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editSankeyChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->editSankeyChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
body =  # UpdateSankeyChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_sankey_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->editSankeyChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getSankeyChart

Get a chart by Id


/service/charts/sankey/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/sankey/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getSankeyChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#getSankeyChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getSankeyChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#getSankeyChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getSankeyChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSankeyChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSankeyChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getSankeyChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.getSankeyChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getSankeyChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->getSankeyChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getSankeyChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->getSankeyChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_sankey_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->getSankeyChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getSankeyChartConfig

Get the configuration informations of an existing chart


/service/charts/sankey/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/sankey/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SankeyChartControllerApi;

import java.io.File;
import java.util.*;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            SankeyChartConfig result = apiInstance.getSankeyChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#getSankeyChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SankeyChartControllerApi;

public class SankeyChartControllerApiExample {

    public static void main(String[] args) {
        SankeyChartControllerApi apiInstance = new SankeyChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            SankeyChartConfig result = apiInstance.getSankeyChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SankeyChartControllerApi#getSankeyChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

SankeyChartControllerApi *apiInstance = [[SankeyChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getSankeyChartConfigWith:id
    project:project
              completionHandler: ^(SankeyChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SankeyChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSankeyChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSankeyChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SankeyChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                SankeyChartConfig result = apiInstance.getSankeyChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SankeyChartControllerApi.getSankeyChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSankeyChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getSankeyChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SankeyChartControllerApi->getSankeyChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SankeyChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SankeyChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getSankeyChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SankeyChartControllerApi->getSankeyChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SankeyChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_sankey_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SankeyChartControllerApi->getSankeyChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ScatterChartController

checkConfigUsingGET13

Check the configuration informations of an existing chart


/service/charts/scatter/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/scatter/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET13(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#checkConfigUsingGET13");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET13(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#checkConfigUsingGET13");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET13With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET13(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET13Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET13(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.checkConfigUsingGET13: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET13($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->checkConfigUsingGET13: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET13(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->checkConfigUsingGET13: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get13(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->checkConfigUsingGET13: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createScatterChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/scatter

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/scatter?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createScatterChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#createScatterChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createScatterChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#createScatterChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Create a new chart
[apiInstance createScatterChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScatterChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createScatterChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createScatterChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.createScatterChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createScatterChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->createScatterChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createScatterChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->createScatterChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_scatter_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->createScatterChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createScatterChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/scatter/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/scatter/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createScatterChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#createScatterChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createScatterChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#createScatterChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createScatterChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScatterChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createScatterChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createScatterChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.createScatterChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createScatterChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->createScatterChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createScatterChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->createScatterChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_scatter_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->createScatterChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteScatterChart

Delete an existing chart


/service/charts/scatter/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/scatter/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteScatterChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#deleteScatterChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteScatterChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#deleteScatterChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteScatterChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteScatterChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteScatterChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteScatterChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.deleteScatterChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteScatterChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->deleteScatterChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteScatterChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->deleteScatterChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_scatter_chart(id, project=project)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->deleteScatterChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateScatterChart

Duplicate an existing chart


/service/charts/scatter/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/scatter/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateScatterChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#duplicateScatterChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateScatterChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#duplicateScatterChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateScatterChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateScatterChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateScatterChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateScatterChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.duplicateScatterChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateScatterChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->duplicateScatterChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateScatterChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->duplicateScatterChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_scatter_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->duplicateScatterChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editScatterChart

Edit chart

Edit an existing chart


/service/charts/scatter/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/scatter/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editScatterChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#editScatterChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editScatterChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#editScatterChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Edit chart
[apiInstance editScatterChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editScatterChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editScatterChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editScatterChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.editScatterChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editScatterChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->editScatterChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editScatterChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->editScatterChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_scatter_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->editScatterChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editScatterChartConfig

Update the configuration informations of an existing chart


/service/charts/scatter/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/scatter/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        UpdateScatterChartConfigEntry body = ; // UpdateScatterChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editScatterChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#editScatterChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        UpdateScatterChartConfigEntry body = ; // UpdateScatterChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editScatterChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#editScatterChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateScatterChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editScatterChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var body = ; // {{UpdateScatterChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editScatterChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editScatterChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var body = new UpdateScatterChartConfigEntry(); // UpdateScatterChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editScatterChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.editScatterChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$body = ; // UpdateScatterChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editScatterChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->editScatterChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateScatterChartConfigEntry->new(); # UpdateScatterChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editScatterChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->editScatterChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
body =  # UpdateScatterChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_scatter_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->editScatterChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getScatterChart

Get a chart by Id


/service/charts/scatter/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/scatter/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getScatterChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#getScatterChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getScatterChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#getScatterChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getScatterChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScatterChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScatterChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getScatterChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.getScatterChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getScatterChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->getScatterChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getScatterChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->getScatterChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_scatter_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->getScatterChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getScatterChartConfig

Get the configuration informations of an existing chart


/service/charts/scatter/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/scatter/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScatterChartControllerApi;

import java.io.File;
import java.util.*;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            ScatterChartConfig result = apiInstance.getScatterChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#getScatterChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScatterChartControllerApi;

public class ScatterChartControllerApiExample {

    public static void main(String[] args) {
        ScatterChartControllerApi apiInstance = new ScatterChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            ScatterChartConfig result = apiInstance.getScatterChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScatterChartControllerApi#getScatterChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

ScatterChartControllerApi *apiInstance = [[ScatterChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getScatterChartConfigWith:id
    project:project
              completionHandler: ^(ScatterChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ScatterChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScatterChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScatterChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScatterChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                ScatterChartConfig result = apiInstance.getScatterChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScatterChartControllerApi.getScatterChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiScatterChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getScatterChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScatterChartControllerApi->getScatterChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScatterChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScatterChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getScatterChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScatterChartControllerApi->getScatterChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScatterChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_scatter_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScatterChartControllerApi->getScatterChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ServerInfoController

getJsonApiPaths

Get Json api paths


/service/private/apiPaths

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/private/apiPaths"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServerInfoControllerApi;

import java.io.File;
import java.util.*;

public class ServerInfoControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ServerInfoControllerApi apiInstance = new ServerInfoControllerApi();
        try {
            'String' result = apiInstance.getJsonApiPaths();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerInfoControllerApi#getJsonApiPaths");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServerInfoControllerApi;

public class ServerInfoControllerApiExample {

    public static void main(String[] args) {
        ServerInfoControllerApi apiInstance = new ServerInfoControllerApi();
        try {
            'String' result = apiInstance.getJsonApiPaths();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerInfoControllerApi#getJsonApiPaths");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ServerInfoControllerApi *apiInstance = [[ServerInfoControllerApi alloc] init];

// Get Json api paths
[apiInstance getJsonApiPathsWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ServerInfoControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonApiPaths(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonApiPathsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ServerInfoControllerApi();

            try
            {
                // Get Json api paths
                'String' result = apiInstance.getJsonApiPaths();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServerInfoControllerApi.getJsonApiPaths: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiServerInfoControllerApi();

try {
    $result = $api_instance->getJsonApiPaths();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerInfoControllerApi->getJsonApiPaths: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServerInfoControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ServerInfoControllerApi->new();

eval { 
    my $result = $api_instance->getJsonApiPaths();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServerInfoControllerApi->getJsonApiPaths: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ServerInfoControllerApi()

try: 
    # Get Json api paths
    api_response = api_instance.get_json_api_paths()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServerInfoControllerApi->getJsonApiPaths: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getVersionInfo

Get instance version information


/service/version

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServerInfoControllerApi;

import java.io.File;
import java.util.*;

public class ServerInfoControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ServerInfoControllerApi apiInstance = new ServerInfoControllerApi();
        try {
            map['String', Object] result = apiInstance.getVersionInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerInfoControllerApi#getVersionInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServerInfoControllerApi;

public class ServerInfoControllerApiExample {

    public static void main(String[] args) {
        ServerInfoControllerApi apiInstance = new ServerInfoControllerApi();
        try {
            map['String', Object] result = apiInstance.getVersionInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerInfoControllerApi#getVersionInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

ServerInfoControllerApi *apiInstance = [[ServerInfoControllerApi alloc] init];

// Get instance version information
[apiInstance getVersionInfoWithCompletionHandler: 
              ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ServerInfoControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVersionInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVersionInfoExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ServerInfoControllerApi();

            try
            {
                // Get instance version information
                map['String', Object] result = apiInstance.getVersionInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServerInfoControllerApi.getVersionInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiServerInfoControllerApi();

try {
    $result = $api_instance->getVersionInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerInfoControllerApi->getVersionInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServerInfoControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ServerInfoControllerApi->new();

eval { 
    my $result = $api_instance->getVersionInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServerInfoControllerApi->getVersionInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ServerInfoControllerApi()

try: 
    # Get instance version information
    api_response = api_instance.get_version_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServerInfoControllerApi->getVersionInfo: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


SftpConnectorController

checkSFTPConnection

Check a SFTP connector connectivity


/service/connectors/sftp/check_connection

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/sftp/check_connection?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkSFTPConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#checkSFTPConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkSFTPConnection(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#checkSFTPConnection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
SFTPConnector *body = ; // sftpConnector
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// Check a SFTP connector connectivity
[apiInstance checkSFTPConnectionWith:body
    ctx:ctx
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var body = ; // {{SFTPConnector}} sftpConnector
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkSFTPConnection(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkSFTPConnectionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var body = new SFTPConnector(); // SFTPConnector | sftpConnector
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check a SFTP connector connectivity
                'Boolean' result = apiInstance.checkSFTPConnection(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.checkSFTPConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$body = ; // SFTPConnector | sftpConnector
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkSFTPConnection($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->checkSFTPConnection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::SFTPConnector->new(); # SFTPConnector | sftpConnector
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkSFTPConnection(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->checkSFTPConnection: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
body =  # SFTPConnector | sftpConnector
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Check a SFTP connector connectivity
    api_response = api_instance.check_sftp_connection(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->checkSFTPConnection: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createSFTPConnector

Create a new SFTP connector

Create a new SFTP connector and return the created object


/service/connectors/sftp

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/sftp?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Long project = 789; // Long | Project id
        try {
            SFTPConnector result = apiInstance.createSFTPConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#createSFTPConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Long project = 789; // Long | Project id
        try {
            SFTPConnector result = apiInstance.createSFTPConnector(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#createSFTPConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
SFTPConnector *body = ; // sftpConnector
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// Create a new SFTP connector
[apiInstance createSFTPConnectorWith:body
    project:project
              completionHandler: ^(SFTPConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var body = ; // {{SFTPConnector}} sftpConnector
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSFTPConnector(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSFTPConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var body = new SFTPConnector(); // SFTPConnector | sftpConnector
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new SFTP connector
                SFTPConnector result = apiInstance.createSFTPConnector(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.createSFTPConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$body = ; // SFTPConnector | sftpConnector
$project = 789; // Long | Project id

try {
    $result = $api_instance->createSFTPConnector($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->createSFTPConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::SFTPConnector->new(); # SFTPConnector | sftpConnector
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createSFTPConnector(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->createSFTPConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
body =  # SFTPConnector | sftpConnector
project = 789 # Long | Project id (optional)

try: 
    # Create a new SFTP connector
    api_response = api_instance.create_sftp_connector(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->createSFTPConnector: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteSFTPConnector

Delete a SFTP connector

Delete an existing DB connector for a given ID and return the delete object ID


/service/connectors/sftp/{connectorId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/connectors/sftp/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteSFTPConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#deleteSFTPConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteSFTPConnector(connectorId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#deleteSFTPConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// Delete a SFTP connector
[apiInstance deleteSFTPConnectorWith:connectorId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSFTPConnector(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteSFTPConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a SFTP connector
                apiInstance.deleteSFTPConnector(connectorId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.deleteSFTPConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $api_instance->deleteSFTPConnector($connectorId, $project);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->deleteSFTPConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteSFTPConnector(connectorId => $connectorId, project => $project);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->deleteSFTPConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Delete a SFTP connector
    api_instance.delete_sftp_connector(connectorId, project=project)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->deleteSFTPConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editSFTPConnector

Edit a SFTP connector

Edit an existing SFTP connector and return the updated object


/service/connectors/sftp/{connectorId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/sftp/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            SFTPConnector result = apiInstance.editSFTPConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#editSFTPConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            SFTPConnector result = apiInstance.editSFTPConnector(body, connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#editSFTPConnector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
SFTPConnector *body = ; // sftpConnector
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// Edit a SFTP connector
[apiInstance editSFTPConnectorWith:body
    connectorId:connectorId
    project:project
              completionHandler: ^(SFTPConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var body = ; // {{SFTPConnector}} sftpConnector
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editSFTPConnector(bodyconnectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editSFTPConnectorExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var body = new SFTPConnector(); // SFTPConnector | sftpConnector
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit a SFTP connector
                SFTPConnector result = apiInstance.editSFTPConnector(body, connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.editSFTPConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$body = ; // SFTPConnector | sftpConnector
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editSFTPConnector($body, $connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->editSFTPConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::SFTPConnector->new(); # SFTPConnector | sftpConnector
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editSFTPConnector(body => $body, connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->editSFTPConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
body =  # SFTPConnector | sftpConnector
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Edit a SFTP connector
    api_response = api_instance.edit_sftp_connector(body, connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->editSFTPConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllSFTPConnectors

View a list of SFTP connectors


/service/connectors/sftp

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/sftp?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[SFTPConnector] result = apiInstance.findAllSFTPConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#findAllSFTPConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[SFTPConnector] result = apiInstance.findAllSFTPConnectors(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#findAllSFTPConnectors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// View a list of SFTP connectors
[apiInstance findAllSFTPConnectorsWith:project
              completionHandler: ^(array[SFTPConnector] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllSFTPConnectors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllSFTPConnectorsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // View a list of SFTP connectors
                array[SFTPConnector] result = apiInstance.findAllSFTPConnectors(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.findAllSFTPConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllSFTPConnectors($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->findAllSFTPConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllSFTPConnectors(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->findAllSFTPConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # View a list of SFTP connectors
    api_response = api_instance.find_all_sftp_connectors(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->findAllSFTPConnectors: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneSFTPConnectorById

Get a SFTP connector by ID


/service/connectors/sftp/{connectorId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/sftp/{connectorId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            SFTPConnector result = apiInstance.findOneSFTPConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#findOneSFTPConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Long project = 789; // Long | Project id
        try {
            SFTPConnector result = apiInstance.findOneSFTPConnectorById(connectorId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#findOneSFTPConnectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// Get a SFTP connector by ID
[apiInstance findOneSFTPConnectorByIdWith:connectorId
    project:project
              completionHandler: ^(SFTPConnector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneSFTPConnectorById(connectorId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneSFTPConnectorByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a SFTP connector by ID
                SFTPConnector result = apiInstance.findOneSFTPConnectorById(connectorId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.findOneSFTPConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneSFTPConnectorById($connectorId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->findOneSFTPConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneSFTPConnectorById(connectorId => $connectorId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->findOneSFTPConnectorById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
connectorId = 789 # Long | connectorId
project = 789 # Long | Project id (optional)

try: 
    # Get a SFTP connector by ID
    api_response = api_instance.find_one_sftp_connector_by_id(connectorId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->findOneSFTPConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listSFTPRemoteFiles

List SFTP remote files


/service/connectors/files/sftp

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/connectors/files/sftp?ctx=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listSFTPRemoteFiles(body, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#listSFTPRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        SFTPConnector body = ; // SFTPConnector | sftpConnector
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listSFTPRemoteFiles(body, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#listSFTPRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
SFTPConnector *body = ; // sftpConnector
Integer *ctx = 56; // ctx
String *remotePath = remotePath_example; // remotePath
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// List SFTP remote files
[apiInstance listSFTPRemoteFilesWith:body
    ctx:ctx
    remotePath:remotePath
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var body = ; // {{SFTPConnector}} sftpConnector
var ctx = 56; // {{Integer}} ctx
var remotePath = remotePath_example; // {{String}} remotePath
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSFTPRemoteFiles(bodyctxremotePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSFTPRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var body = new SFTPConnector(); // SFTPConnector | sftpConnector
            var ctx = 56;  // Integer | ctx
            var remotePath = remotePath_example;  // String | remotePath
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // List SFTP remote files
                'Boolean' result = apiInstance.listSFTPRemoteFiles(body, ctx, remotePath, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.listSFTPRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$body = ; // SFTPConnector | sftpConnector
$ctx = 56; // Integer | ctx
$remotePath = remotePath_example; // String | remotePath
$project = 789; // Long | Project id

try {
    $result = $api_instance->listSFTPRemoteFiles($body, $ctx, $remotePath, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->listSFTPRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $body = WWW::SwaggerClient::Object::SFTPConnector->new(); # SFTPConnector | sftpConnector
my $ctx = 56; # Integer | ctx
my $remotePath = remotePath_example; # String | remotePath
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listSFTPRemoteFiles(body => $body, ctx => $ctx, remotePath => $remotePath, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->listSFTPRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
body =  # SFTPConnector | sftpConnector
ctx = 56 # Integer | ctx
remotePath = remotePath_example # String | remotePath
project = 789 # Long | Project id (optional)

try: 
    # List SFTP remote files
    api_response = api_instance.list_sftp_remote_files(body, ctx, remotePath, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->listSFTPRemoteFiles: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
remotePath*
String
remotePath
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listSFTPRemoteFilesById

List SFTP remote files by id


/service/connectors/sftp/{connectorId}/files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/connectors/sftp/{connectorId}/files?ctx=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SftpConnectorControllerApi;

import java.io.File;
import java.util.*;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listSFTPRemoteFilesById(connectorId, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#listSFTPRemoteFilesById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SftpConnectorControllerApi;

public class SftpConnectorControllerApiExample {

    public static void main(String[] args) {
        SftpConnectorControllerApi apiInstance = new SftpConnectorControllerApi();
        Long connectorId = 789; // Long | connectorId
        Integer ctx = 56; // Integer | ctx
        String remotePath = remotePath_example; // String | remotePath
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.listSFTPRemoteFilesById(connectorId, ctx, remotePath, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SftpConnectorControllerApi#listSFTPRemoteFilesById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *connectorId = 789; // connectorId
Integer *ctx = 56; // ctx
String *remotePath = remotePath_example; // remotePath
Long *project = 789; // Project id (optional)

SftpConnectorControllerApi *apiInstance = [[SftpConnectorControllerApi alloc] init];

// List SFTP remote files by id
[apiInstance listSFTPRemoteFilesByIdWith:connectorId
    ctx:ctx
    remotePath:remotePath
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SftpConnectorControllerApi()
var connectorId = 789; // {{Long}} connectorId
var ctx = 56; // {{Integer}} ctx
var remotePath = remotePath_example; // {{String}} remotePath
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSFTPRemoteFilesById(connectorId, ctx, remotePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSFTPRemoteFilesByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SftpConnectorControllerApi();
            var connectorId = 789;  // Long | connectorId
            var ctx = 56;  // Integer | ctx
            var remotePath = remotePath_example;  // String | remotePath
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // List SFTP remote files by id
                'Boolean' result = apiInstance.listSFTPRemoteFilesById(connectorId, ctx, remotePath, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SftpConnectorControllerApi.listSFTPRemoteFilesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSftpConnectorControllerApi();
$connectorId = 789; // Long | connectorId
$ctx = 56; // Integer | ctx
$remotePath = remotePath_example; // String | remotePath
$project = 789; // Long | Project id

try {
    $result = $api_instance->listSFTPRemoteFilesById($connectorId, $ctx, $remotePath, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SftpConnectorControllerApi->listSFTPRemoteFilesById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SftpConnectorControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SftpConnectorControllerApi->new();
my $connectorId = 789; # Long | connectorId
my $ctx = 56; # Integer | ctx
my $remotePath = remotePath_example; # String | remotePath
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->listSFTPRemoteFilesById(connectorId => $connectorId, ctx => $ctx, remotePath => $remotePath, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SftpConnectorControllerApi->listSFTPRemoteFilesById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SftpConnectorControllerApi()
connectorId = 789 # Long | connectorId
ctx = 56 # Integer | ctx
remotePath = remotePath_example # String | remotePath
project = 789 # Long | Project id (optional)

try: 
    # List SFTP remote files by id
    api_response = api_instance.list_sftp_remote_files_by_id(connectorId, ctx, remotePath, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SftpConnectorControllerApi->listSFTPRemoteFilesById: %s\n" % e)

Parameters

Path parameters
Name Description
connectorId*
Long (int64)
connectorId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id
remotePath*
String
remotePath
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


SimpleGridController

checkConfigUsingGET14

Check the configuration informations of an existing grid


/service/grids/simple/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/simple/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET14(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#checkConfigUsingGET14");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET14(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#checkConfigUsingGET14");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdGrid Id
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Check the configuration informations of an existing grid
[apiInstance checkConfigUsingGET14With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var id = 789; // {{Long}} HdGrid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET14(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET14Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var id = 789;  // Long | HdGrid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing grid
                'Boolean' result = apiInstance.checkConfigUsingGET14(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.checkConfigUsingGET14: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$id = 789; // Long | HdGrid Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET14($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->checkConfigUsingGET14: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $id = 789; # Long | HdGrid Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET14(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->checkConfigUsingGET14: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
id = 789 # Long | HdGrid Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing grid
    api_response = api_instance.check_config_using_get14(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->checkConfigUsingGET14: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdGrid Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createFromDbUsingPOST1

Create a new grid from datablock

Create a new grid from datablock and returns the new generated id


/service/grids/simple/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/simple/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long body = ; // Long | Datablock Id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFromDbUsingPOST1(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#createFromDbUsingPOST1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long body = ; // Long | Datablock Id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createFromDbUsingPOST1(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#createFromDbUsingPOST1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *body = ; // Datablock Id
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Create a new grid from datablock
[apiInstance createFromDbUsingPOST1With:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var body = ; // {{Long}} Datablock Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFromDbUsingPOST1(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFromDbUsingPOST1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var body = new Long(); // Long | Datablock Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new grid from datablock
                Long result = apiInstance.createFromDbUsingPOST1(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.createFromDbUsingPOST1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$body = ; // Long | Datablock Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->createFromDbUsingPOST1($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->createFromDbUsingPOST1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | Datablock Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createFromDbUsingPOST1(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->createFromDbUsingPOST1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
body =  # Long | Datablock Id
project = 789 # Long | Project id (optional)

try: 
    # Create a new grid from datablock
    api_response = api_instance.create_from_db_using_post1(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->createFromDbUsingPOST1: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createUsingPOST1

Create a new grid

Create a new grid and returns the new generated id


/service/grids/simple

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/simple?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        CreateGridEntry body = ; // CreateGridEntry | grid
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createUsingPOST1(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#createUsingPOST1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        CreateGridEntry body = ; // CreateGridEntry | grid
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createUsingPOST1(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#createUsingPOST1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateGridEntry *body = ; // grid
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Create a new grid
[apiInstance createUsingPOST1With:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var body = ; // {{CreateGridEntry}} grid
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUsingPOST1(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUsingPOST1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var body = new CreateGridEntry(); // CreateGridEntry | grid
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new grid
                Long result = apiInstance.createUsingPOST1(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.createUsingPOST1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$body = ; // CreateGridEntry | grid
$project = 789; // Long | Project id

try {
    $result = $api_instance->createUsingPOST1($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->createUsingPOST1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateGridEntry->new(); # CreateGridEntry | grid
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createUsingPOST1(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->createUsingPOST1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
body =  # CreateGridEntry | grid
project = 789 # Long | Project id (optional)

try: 
    # Create a new grid
    api_response = api_instance.create_using_post1(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->createUsingPOST1: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteUsingDELETE1

Delete an existing grid


/service/grids/simple/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/grids/simple/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteUsingDELETE1(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#deleteUsingDELETE1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteUsingDELETE1(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#deleteUsingDELETE1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the grid to be deleted
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Delete an existing grid
[apiInstance deleteUsingDELETE1With:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var id = 789; // {{Long}} The Id of the grid to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUsingDELETE1(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUsingDELETE1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var id = 789;  // Long | The Id of the grid to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing grid
                apiInstance.deleteUsingDELETE1(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.deleteUsingDELETE1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$id = 789; // Long | The Id of the grid to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteUsingDELETE1($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->deleteUsingDELETE1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $id = 789; # Long | The Id of the grid to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteUsingDELETE1(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->deleteUsingDELETE1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
id = 789 # Long | The Id of the grid to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing grid
    api_instance.delete_using_delete1(id, project=project)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->deleteUsingDELETE1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the grid to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateUsingPOST1

Duplicate an existing grid


/service/grids/simple/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/grids/simple/{id}/duplicate?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateUsingPOST1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#duplicateUsingPOST1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | The Id of the grid to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateUsingPOST1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#duplicateUsingPOST1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the grid to be duplicated
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Duplicate an existing grid
[apiInstance duplicateUsingPOST1With:id
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var id = 789; // {{Long}} The Id of the grid to be duplicated
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateUsingPOST1(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateUsingPOST1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var id = 789;  // Long | The Id of the grid to be duplicated
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Duplicate an existing grid
                Long result = apiInstance.duplicateUsingPOST1(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.duplicateUsingPOST1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$id = 789; // Long | The Id of the grid to be duplicated
$project = 789; // Long | Project id

try {
    $result = $api_instance->duplicateUsingPOST1($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->duplicateUsingPOST1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $id = 789; # Long | The Id of the grid to be duplicated
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->duplicateUsingPOST1(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->duplicateUsingPOST1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
id = 789 # Long | The Id of the grid to be duplicated
project = 789 # Long | Project id (optional)

try: 
    # Duplicate an existing grid
    api_response = api_instance.duplicate_using_post1(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->duplicateUsingPOST1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the grid to be duplicated
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editConfigUsingPUT1

Update the configuration informations of an existing grid


/service/grids/simple/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/simple/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        UpdateSimpleGridConfigEntry body = ; // UpdateSimpleGridConfigEntry | The update configuration data
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editConfigUsingPUT1(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#editConfigUsingPUT1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        UpdateSimpleGridConfigEntry body = ; // UpdateSimpleGridConfigEntry | The update configuration data
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editConfigUsingPUT1(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#editConfigUsingPUT1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateSimpleGridConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdGrid Id
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Update the configuration informations of an existing grid
[apiInstance editConfigUsingPUT1With:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var body = ; // {{UpdateSimpleGridConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdGrid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editConfigUsingPUT1(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editConfigUsingPUT1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var body = new UpdateSimpleGridConfigEntry(); // UpdateSimpleGridConfigEntry | The update configuration data
            var id = 789;  // Long | HdGrid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing grid
                apiInstance.editConfigUsingPUT1(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.editConfigUsingPUT1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$body = ; // UpdateSimpleGridConfigEntry | The update configuration data
$id = 789; // Long | HdGrid Id
$project = 789; // Long | Project id

try {
    $api_instance->editConfigUsingPUT1($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->editConfigUsingPUT1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateSimpleGridConfigEntry->new(); # UpdateSimpleGridConfigEntry | The update configuration data
my $id = 789; # Long | HdGrid Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editConfigUsingPUT1(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->editConfigUsingPUT1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
body =  # UpdateSimpleGridConfigEntry | The update configuration data
id = 789 # Long | HdGrid Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing grid
    api_instance.edit_config_using_put1(body, id, project=project)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->editConfigUsingPUT1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdGrid Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editUsingPUT1

Edit grid

Edit an existing grid


/service/grids/simple/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/grids/simple/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        UpdateGridEntry body = ; // UpdateGridEntry | Update grid data
        Long id = 789; // Long | Id of grid to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editUsingPUT1(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#editUsingPUT1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        UpdateGridEntry body = ; // UpdateGridEntry | Update grid data
        Long id = 789; // Long | Id of grid to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editUsingPUT1(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#editUsingPUT1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateGridEntry *body = ; // Update grid data
Long *id = 789; // Id of grid to update data
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Edit grid
[apiInstance editUsingPUT1With:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var body = ; // {{UpdateGridEntry}} Update grid data
var id = 789; // {{Long}} Id of grid to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editUsingPUT1(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editUsingPUT1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var body = new UpdateGridEntry(); // UpdateGridEntry | Update grid data
            var id = 789;  // Long | Id of grid to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit grid
                apiInstance.editUsingPUT1(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.editUsingPUT1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$body = ; // UpdateGridEntry | Update grid data
$id = 789; // Long | Id of grid to update data
$project = 789; // Long | Project id

try {
    $api_instance->editUsingPUT1($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->editUsingPUT1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateGridEntry->new(); # UpdateGridEntry | Update grid data
my $id = 789; # Long | Id of grid to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editUsingPUT1(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->editUsingPUT1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
body =  # UpdateGridEntry | Update grid data
id = 789 # Long | Id of grid to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit grid
    api_instance.edit_using_put1(body, id, project=project)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->editUsingPUT1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of grid to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getConfigUsingGET1

Get the configuration informations of an existing grid


/service/grids/simple/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/simple/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            SimpleGridConfig result = apiInstance.getConfigUsingGET1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#getConfigUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | HdGrid Id
        Long project = 789; // Long | Project id
        try {
            SimpleGridConfig result = apiInstance.getConfigUsingGET1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#getConfigUsingGET1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdGrid Id
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Get the configuration informations of an existing grid
[apiInstance getConfigUsingGET1With:id
    project:project
              completionHandler: ^(SimpleGridConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var id = 789; // {{Long}} HdGrid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfigUsingGET1(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConfigUsingGET1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var id = 789;  // Long | HdGrid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing grid
                SimpleGridConfig result = apiInstance.getConfigUsingGET1(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.getConfigUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$id = 789; // Long | HdGrid Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getConfigUsingGET1($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->getConfigUsingGET1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $id = 789; # Long | HdGrid Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getConfigUsingGET1(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->getConfigUsingGET1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
id = 789 # Long | HdGrid Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing grid
    api_response = api_instance.get_config_using_get1(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->getConfigUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdGrid Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getUsingGET1

Get a grid by Id


/service/grids/simple/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/grids/simple/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimpleGridControllerApi;

import java.io.File;
import java.util.*;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | Requested grid Id
        Long project = 789; // Long | Project id
        try {
            HdGrid result = apiInstance.getUsingGET1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#getUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimpleGridControllerApi;

public class SimpleGridControllerApiExample {

    public static void main(String[] args) {
        SimpleGridControllerApi apiInstance = new SimpleGridControllerApi();
        Long id = 789; // Long | Requested grid Id
        Long project = 789; // Long | Project id
        try {
            HdGrid result = apiInstance.getUsingGET1(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimpleGridControllerApi#getUsingGET1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested grid Id
Long *project = 789; // Project id (optional)

SimpleGridControllerApi *apiInstance = [[SimpleGridControllerApi alloc] init];

// Get a grid by Id
[apiInstance getUsingGET1With:id
    project:project
              completionHandler: ^(HdGrid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SimpleGridControllerApi()
var id = 789; // {{Long}} Requested grid Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsingGET1(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsingGET1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SimpleGridControllerApi();
            var id = 789;  // Long | Requested grid Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a grid by Id
                HdGrid result = apiInstance.getUsingGET1(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimpleGridControllerApi.getUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSimpleGridControllerApi();
$id = 789; // Long | Requested grid Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getUsingGET1($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimpleGridControllerApi->getUsingGET1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimpleGridControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SimpleGridControllerApi->new();
my $id = 789; # Long | Requested grid Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getUsingGET1(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimpleGridControllerApi->getUsingGET1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SimpleGridControllerApi()
id = 789 # Long | Requested grid Id
project = 789 # Long | Project id (optional)

try: 
    # Get a grid by Id
    api_response = api_instance.get_using_get1(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimpleGridControllerApi->getUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested grid Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


SmallLanguageController

translateUsingPOST

translate


/service/sl/translate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/sl/translate?datablock=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SmallLanguageControllerApi;

import java.io.File;
import java.util.*;

public class SmallLanguageControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SmallLanguageControllerApi apiInstance = new SmallLanguageControllerApi();
        array[String] body = ; // array[String] | paths
        Long datablock = 789; // Long | Project id
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.translateUsingPOST(body, datablock, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SmallLanguageControllerApi#translateUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SmallLanguageControllerApi;

public class SmallLanguageControllerApiExample {

    public static void main(String[] args) {
        SmallLanguageControllerApi apiInstance = new SmallLanguageControllerApi();
        array[String] body = ; // array[String] | paths
        Long datablock = 789; // Long | Project id
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.translateUsingPOST(body, datablock, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SmallLanguageControllerApi#translateUsingPOST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *body = ; // paths
Long *datablock = 789; // Project id (optional)
Long *project = 789; // Project id (optional)

SmallLanguageControllerApi *apiInstance = [[SmallLanguageControllerApi alloc] init];

// translate
[apiInstance translateUsingPOSTWith:body
    datablock:datablock
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SmallLanguageControllerApi()
var body = ; // {{array[String]}} paths
var opts = { 
  'datablock': 789 // {{Long}} Project id
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.translateUsingPOST(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class translateUsingPOSTExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SmallLanguageControllerApi();
            var body = new array[String](); // array[String] | paths
            var datablock = 789;  // Long | Project id (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // translate
                array['String'] result = apiInstance.translateUsingPOST(body, datablock, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmallLanguageControllerApi.translateUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSmallLanguageControllerApi();
$body = ; // array[String] | paths
$datablock = 789; // Long | Project id
$project = 789; // Long | Project id

try {
    $result = $api_instance->translateUsingPOST($body, $datablock, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmallLanguageControllerApi->translateUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SmallLanguageControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SmallLanguageControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | paths
my $datablock = 789; # Long | Project id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->translateUsingPOST(body => $body, datablock => $datablock, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SmallLanguageControllerApi->translateUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SmallLanguageControllerApi()
body =  # array[String] | paths
datablock = 789 # Long | Project id (optional)
project = 789 # Long | Project id (optional)

try: 
    # translate
    api_response = api_instance.translate_using_post(body, datablock=datablock, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SmallLanguageControllerApi->translateUsingPOST: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
datablock
Long (int64)
Project id
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


SparkJobsController

findOneByIdUsingGET

findOneById


/service/jobs/{jobKey}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/jobs/{jobKey}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SparkJobsControllerApi;

import java.io.File;
import java.util.*;

public class SparkJobsControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        SparkJobsControllerApi apiInstance = new SparkJobsControllerApi();
        String jobKey = jobKey_example; // String | jobKey
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobDTO result = apiInstance.findOneByIdUsingGET(jobKey, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SparkJobsControllerApi#findOneByIdUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SparkJobsControllerApi;

public class SparkJobsControllerApiExample {

    public static void main(String[] args) {
        SparkJobsControllerApi apiInstance = new SparkJobsControllerApi();
        String jobKey = jobKey_example; // String | jobKey
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            JobDTO result = apiInstance.findOneByIdUsingGET(jobKey, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SparkJobsControllerApi#findOneByIdUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *jobKey = jobKey_example; // jobKey
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

SparkJobsControllerApi *apiInstance = [[SparkJobsControllerApi alloc] init];

// findOneById
[apiInstance findOneByIdUsingGETWith:jobKey
    ctx:ctx
    project:project
              completionHandler: ^(JobDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.SparkJobsControllerApi()
var jobKey = jobKey_example; // {{String}} jobKey
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneByIdUsingGET(jobKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneByIdUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SparkJobsControllerApi();
            var jobKey = jobKey_example;  // String | jobKey
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // findOneById
                JobDTO result = apiInstance.findOneByIdUsingGET(jobKey, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SparkJobsControllerApi.findOneByIdUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSparkJobsControllerApi();
$jobKey = jobKey_example; // String | jobKey
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->findOneByIdUsingGET($jobKey, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SparkJobsControllerApi->findOneByIdUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SparkJobsControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SparkJobsControllerApi->new();
my $jobKey = jobKey_example; # String | jobKey
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findOneByIdUsingGET(jobKey => $jobKey, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SparkJobsControllerApi->findOneByIdUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SparkJobsControllerApi()
jobKey = jobKey_example # String | jobKey
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # findOneById
    api_response = api_instance.find_one_by_id_using_get(jobKey, ctx=ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SparkJobsControllerApi->findOneByIdUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
jobKey*
String
jobKey
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


StorageModeController

getAllStorageModes

Get all storage modes


/service/storage_modes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/storage_modes?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StorageModeControllerApi;

import java.io.File;
import java.util.*;

public class StorageModeControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        StorageModeControllerApi apiInstance = new StorageModeControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[StorageMode] result = apiInstance.getAllStorageModes(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageModeControllerApi#getAllStorageModes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StorageModeControllerApi;

public class StorageModeControllerApiExample {

    public static void main(String[] args) {
        StorageModeControllerApi apiInstance = new StorageModeControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[StorageMode] result = apiInstance.getAllStorageModes(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StorageModeControllerApi#getAllStorageModes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

StorageModeControllerApi *apiInstance = [[StorageModeControllerApi alloc] init];

// Get all storage modes
[apiInstance getAllStorageModesWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[StorageMode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.StorageModeControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllStorageModes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllStorageModesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StorageModeControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get all storage modes
                array[StorageMode] result = apiInstance.getAllStorageModes(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageModeControllerApi.getAllStorageModes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStorageModeControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->getAllStorageModes($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageModeControllerApi->getAllStorageModes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StorageModeControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StorageModeControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->getAllStorageModes(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StorageModeControllerApi->getAllStorageModes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StorageModeControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get all storage modes
    api_response = api_instance.get_all_storage_modes(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StorageModeControllerApi->getAllStorageModes: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


TagController

createTag

Create new tag


/service/tags

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagControllerApi;

import java.io.File;
import java.util.*;

public class TagControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TagControllerApi apiInstance = new TagControllerApi();
        Tag body = ; // Tag | tag
        try {
            Tag result = apiInstance.createTag(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#createTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagControllerApi;

public class TagControllerApiExample {

    public static void main(String[] args) {
        TagControllerApi apiInstance = new TagControllerApi();
        Tag body = ; // Tag | tag
        try {
            Tag result = apiInstance.createTag(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#createTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Tag *body = ; // tag

TagControllerApi *apiInstance = [[TagControllerApi alloc] init];

// Create new tag
[apiInstance createTagWith:body
              completionHandler: ^(Tag output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TagControllerApi()
var body = ; // {{Tag}} tag

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTag(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTagExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TagControllerApi();
            var body = new Tag(); // Tag | tag

            try
            {
                // Create new tag
                Tag result = apiInstance.createTag(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagControllerApi.createTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTagControllerApi();
$body = ; // Tag | tag

try {
    $result = $api_instance->createTag($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagControllerApi->createTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TagControllerApi->new();
my $body = WWW::SwaggerClient::Object::Tag->new(); # Tag | tag

eval { 
    my $result = $api_instance->createTag(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagControllerApi->createTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TagControllerApi()
body =  # Tag | tag

try: 
    # Create new tag
    api_response = api_instance.create_tag(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagControllerApi->createTag: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteTag

Delete an existing tag


/service/tags

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/tags?tagId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagControllerApi;

import java.io.File;
import java.util.*;

public class TagControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TagControllerApi apiInstance = new TagControllerApi();
        Long tagId = 789; // Long | tagId
        try {
            Long result = apiInstance.deleteTag(tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#deleteTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagControllerApi;

public class TagControllerApiExample {

    public static void main(String[] args) {
        TagControllerApi apiInstance = new TagControllerApi();
        Long tagId = 789; // Long | tagId
        try {
            Long result = apiInstance.deleteTag(tagId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#deleteTag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *tagId = 789; // tagId

TagControllerApi *apiInstance = [[TagControllerApi alloc] init];

// Delete an existing tag
[apiInstance deleteTagWith:tagId
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TagControllerApi()
var tagId = 789; // {{Long}} tagId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteTag(tagId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTagExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TagControllerApi();
            var tagId = 789;  // Long | tagId

            try
            {
                // Delete an existing tag
                Long result = apiInstance.deleteTag(tagId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagControllerApi.deleteTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTagControllerApi();
$tagId = 789; // Long | tagId

try {
    $result = $api_instance->deleteTag($tagId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagControllerApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TagControllerApi->new();
my $tagId = 789; # Long | tagId

eval { 
    my $result = $api_instance->deleteTag(tagId => $tagId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagControllerApi->deleteTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TagControllerApi()
tagId = 789 # Long | tagId

try: 
    # Delete an existing tag
    api_response = api_instance.delete_tag(tagId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagControllerApi->deleteTag: %s\n" % e)

Parameters

Query parameters
Name Description
tagId*
Long (int64)
tagId
Required

Responses

Status: 200 - OK


searchTagsByCaracId

Search tags by carac id


/service/tags_carac

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/tags_carac?caracId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagControllerApi;

import java.io.File;
import java.util.*;

public class TagControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TagControllerApi apiInstance = new TagControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            array[Tag] result = apiInstance.searchTagsByCaracId(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#searchTagsByCaracId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagControllerApi;

public class TagControllerApiExample {

    public static void main(String[] args) {
        TagControllerApi apiInstance = new TagControllerApi();
        Long caracId = 789; // Long | caracId
        Long project = 789; // Long | Project id
        try {
            array[Tag] result = apiInstance.searchTagsByCaracId(caracId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#searchTagsByCaracId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *caracId = 789; // caracId
Long *project = 789; // Project id (optional)

TagControllerApi *apiInstance = [[TagControllerApi alloc] init];

// Search tags by carac id
[apiInstance searchTagsByCaracIdWith:caracId
    project:project
              completionHandler: ^(array[Tag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TagControllerApi()
var caracId = 789; // {{Long}} caracId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchTagsByCaracId(caracId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchTagsByCaracIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TagControllerApi();
            var caracId = 789;  // Long | caracId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Search tags by carac id
                array[Tag] result = apiInstance.searchTagsByCaracId(caracId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagControllerApi.searchTagsByCaracId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTagControllerApi();
$caracId = 789; // Long | caracId
$project = 789; // Long | Project id

try {
    $result = $api_instance->searchTagsByCaracId($caracId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagControllerApi->searchTagsByCaracId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TagControllerApi->new();
my $caracId = 789; # Long | caracId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->searchTagsByCaracId(caracId => $caracId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagControllerApi->searchTagsByCaracId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TagControllerApi()
caracId = 789 # Long | caracId
project = 789 # Long | Project id (optional)

try: 
    # Search tags by carac id
    api_response = api_instance.search_tags_by_carac_id(caracId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagControllerApi->searchTagsByCaracId: %s\n" % e)

Parameters

Query parameters
Name Description
caracId*
Long (int64)
caracId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


searchTagsByEntiteId

Search tags by entite id


/service/tags_entite_type

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/tags_entite_type?entiteTypeId=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagControllerApi;

import java.io.File;
import java.util.*;

public class TagControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TagControllerApi apiInstance = new TagControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            array[Tag] result = apiInstance.searchTagsByEntiteId(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#searchTagsByEntiteId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagControllerApi;

public class TagControllerApiExample {

    public static void main(String[] args) {
        TagControllerApi apiInstance = new TagControllerApi();
        Long entiteTypeId = 789; // Long | entiteTypeId
        Long project = 789; // Long | Project id
        try {
            array[Tag] result = apiInstance.searchTagsByEntiteId(entiteTypeId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#searchTagsByEntiteId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *entiteTypeId = 789; // entiteTypeId
Long *project = 789; // Project id (optional)

TagControllerApi *apiInstance = [[TagControllerApi alloc] init];

// Search tags by entite id
[apiInstance searchTagsByEntiteIdWith:entiteTypeId
    project:project
              completionHandler: ^(array[Tag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TagControllerApi()
var entiteTypeId = 789; // {{Long}} entiteTypeId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchTagsByEntiteId(entiteTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchTagsByEntiteIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TagControllerApi();
            var entiteTypeId = 789;  // Long | entiteTypeId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Search tags by entite id
                array[Tag] result = apiInstance.searchTagsByEntiteId(entiteTypeId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagControllerApi.searchTagsByEntiteId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTagControllerApi();
$entiteTypeId = 789; // Long | entiteTypeId
$project = 789; // Long | Project id

try {
    $result = $api_instance->searchTagsByEntiteId($entiteTypeId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagControllerApi->searchTagsByEntiteId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TagControllerApi->new();
my $entiteTypeId = 789; # Long | entiteTypeId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->searchTagsByEntiteId(entiteTypeId => $entiteTypeId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagControllerApi->searchTagsByEntiteId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TagControllerApi()
entiteTypeId = 789 # Long | entiteTypeId
project = 789 # Long | Project id (optional)

try: 
    # Search tags by entite id
    api_response = api_instance.search_tags_by_entite_id(entiteTypeId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagControllerApi->searchTagsByEntiteId: %s\n" % e)

Parameters

Query parameters
Name Description
entiteTypeId*
Long (int64)
entiteTypeId
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


searchTagsByText

Search tags by text


/service/tags

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/tags?text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagControllerApi;

import java.io.File;
import java.util.*;

public class TagControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TagControllerApi apiInstance = new TagControllerApi();
        String text = text_example; // String | text
        try {
            array[Tag] result = apiInstance.searchTagsByText(text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#searchTagsByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagControllerApi;

public class TagControllerApiExample {

    public static void main(String[] args) {
        TagControllerApi apiInstance = new TagControllerApi();
        String text = text_example; // String | text
        try {
            array[Tag] result = apiInstance.searchTagsByText(text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagControllerApi#searchTagsByText");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *text = text_example; // text (optional)

TagControllerApi *apiInstance = [[TagControllerApi alloc] init];

// Search tags by text
[apiInstance searchTagsByTextWith:text
              completionHandler: ^(array[Tag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TagControllerApi()
var opts = { 
  'text': text_example // {{String}} text
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchTagsByText(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchTagsByTextExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TagControllerApi();
            var text = text_example;  // String | text (optional) 

            try
            {
                // Search tags by text
                array[Tag] result = apiInstance.searchTagsByText(text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagControllerApi.searchTagsByText: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTagControllerApi();
$text = text_example; // String | text

try {
    $result = $api_instance->searchTagsByText($text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagControllerApi->searchTagsByText: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TagControllerApi->new();
my $text = text_example; # String | text

eval { 
    my $result = $api_instance->searchTagsByText(text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagControllerApi->searchTagsByText: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TagControllerApi()
text = text_example # String | text (optional)

try: 
    # Search tags by text
    api_response = api_instance.search_tags_by_text(text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagControllerApi->searchTagsByText: %s\n" % e)

Parameters

Query parameters
Name Description
text
String
text

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


TimeLineController

checkConfigUsingGET15

Check the configuration informations of an existing timeline


/service/timelines/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/timelines/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | HdTimeline Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET15(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#checkConfigUsingGET15");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | HdTimeline Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET15(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#checkConfigUsingGET15");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdTimeline Id
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Check the configuration informations of an existing timeline
[apiInstance checkConfigUsingGET15With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var id = 789; // {{Long}} HdTimeline Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET15(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET15Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var id = 789;  // Long | HdTimeline Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing timeline
                'Boolean' result = apiInstance.checkConfigUsingGET15(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.checkConfigUsingGET15: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$id = 789; // Long | HdTimeline Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET15($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->checkConfigUsingGET15: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $id = 789; # Long | HdTimeline Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET15(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->checkConfigUsingGET15: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
id = 789 # Long | HdTimeline Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing timeline
    api_response = api_instance.check_config_using_get15(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->checkConfigUsingGET15: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdTimeline Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createTimeline

Create a new timeline

Create a new timeline and returns the new generated id


/service/timelines

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/timelines?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        CreateTLEntry body = ; // CreateTLEntry | New timeline data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTimeline(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#createTimeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        CreateTLEntry body = ; // CreateTLEntry | New timeline data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTimeline(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#createTimeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateTLEntry *body = ; // New timeline data
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Create a new timeline
[apiInstance createTimelineWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var body = ; // {{CreateTLEntry}} New timeline data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTimeline(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTimelineExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var body = new CreateTLEntry(); // CreateTLEntry | New timeline data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new timeline
                Long result = apiInstance.createTimeline(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.createTimeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$body = ; // CreateTLEntry | New timeline data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createTimeline($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->createTimeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateTLEntry->new(); # CreateTLEntry | New timeline data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createTimeline(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->createTimeline: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
body =  # CreateTLEntry | New timeline data
project = 789 # Long | Project id (optional)

try: 
    # Create a new timeline
    api_response = api_instance.create_timeline(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->createTimeline: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createTimelineFromDb

Create a new timeline from datablock

Create a new timeline from datablock and returns the new generated id


/service/timelines/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/timelines/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long body = ; // Long | Datablock id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTimelineFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#createTimelineFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long body = ; // Long | Datablock id
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTimelineFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#createTimelineFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *body = ; // Datablock id
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Create a new timeline from datablock
[apiInstance createTimelineFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var body = ; // {{Long}} Datablock id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTimelineFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTimelineFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var body = new Long(); // Long | Datablock id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new timeline from datablock
                Long result = apiInstance.createTimelineFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.createTimelineFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$body = ; // Long | Datablock id
$project = 789; // Long | Project id

try {
    $result = $api_instance->createTimelineFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->createTimelineFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $body = WWW::SwaggerClient::Object::Long->new(); # Long | Datablock id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createTimelineFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->createTimelineFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
body =  # Long | Datablock id
project = 789 # Long | Project id (optional)

try: 
    # Create a new timeline from datablock
    api_response = api_instance.create_timeline_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->createTimelineFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteManyTimelines

Delete a list of timelines


/service/timelines

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/timelines?project=&timeLinesId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        array[Long] timeLinesId = ; // array[Long] | Requested timeLinesId Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyTimelines(timeLinesId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#deleteManyTimelines");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        array[Long] timeLinesId = ; // array[Long] | Requested timeLinesId Ids
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteManyTimelines(timeLinesId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#deleteManyTimelines");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[Long] *timeLinesId = ; // Requested timeLinesId Ids
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Delete a list of timelines
[apiInstance deleteManyTimelinesWith:timeLinesId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var timeLinesId = ; // {{array[Long]}} Requested timeLinesId Ids
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteManyTimelines(timeLinesId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteManyTimelinesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var timeLinesId = new array[Long](); // array[Long] | Requested timeLinesId Ids
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete a list of timelines
                apiInstance.deleteManyTimelines(timeLinesId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.deleteManyTimelines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$timeLinesId = ; // array[Long] | Requested timeLinesId Ids
$project = 789; // Long | Project id

try {
    $api_instance->deleteManyTimelines($timeLinesId, $project);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->deleteManyTimelines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $timeLinesId = []; # array[Long] | Requested timeLinesId Ids
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteManyTimelines(timeLinesId => $timeLinesId, project => $project);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->deleteManyTimelines: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
timeLinesId =  # array[Long] | Requested timeLinesId Ids
project = 789 # Long | Project id (optional)

try: 
    # Delete a list of timelines
    api_instance.delete_many_timelines(timeLinesId, project=project)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->deleteManyTimelines: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id
timeLinesId*
array[Long] (int64)
Requested timeLinesId Ids
Required

Responses

Status: 200 - OK


deleteTimeline

Delete an existing timeline


/service/timelines/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/timelines/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | The Id of the timeline to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteTimeline(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#deleteTimeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | The Id of the timeline to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteTimeline(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#deleteTimeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the timeline to be deleted
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Delete an existing timeline
[apiInstance deleteTimelineWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var id = 789; // {{Long}} The Id of the timeline to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTimeline(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTimelineExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var id = 789;  // Long | The Id of the timeline to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing timeline
                apiInstance.deleteTimeline(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.deleteTimeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$id = 789; // Long | The Id of the timeline to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteTimeline($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->deleteTimeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $id = 789; # Long | The Id of the timeline to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteTimeline(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->deleteTimeline: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
id = 789 # Long | The Id of the timeline to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing timeline
    api_instance.delete_timeline(id, project=project)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->deleteTimeline: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the timeline to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateTimeline

Duplicate an existing timeline


/service/timelines/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/timelines/{id}/duplicate?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | The Id of the timeline to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateTimeline(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#duplicateTimeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | The Id of the timeline to be duplicated
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.duplicateTimeline(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#duplicateTimeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the timeline to be duplicated
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Duplicate an existing timeline
[apiInstance duplicateTimelineWith:id
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var id = 789; // {{Long}} The Id of the timeline to be duplicated
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateTimeline(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateTimelineExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var id = 789;  // Long | The Id of the timeline to be duplicated
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Duplicate an existing timeline
                Long result = apiInstance.duplicateTimeline(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.duplicateTimeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$id = 789; // Long | The Id of the timeline to be duplicated
$project = 789; // Long | Project id

try {
    $result = $api_instance->duplicateTimeline($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->duplicateTimeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $id = 789; # Long | The Id of the timeline to be duplicated
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->duplicateTimeline(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->duplicateTimeline: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
id = 789 # Long | The Id of the timeline to be duplicated
project = 789 # Long | Project id (optional)

try: 
    # Duplicate an existing timeline
    api_response = api_instance.duplicate_timeline(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->duplicateTimeline: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the timeline to be duplicated
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editTimeline

Edit timeline

Edit an existing timeline


/service/timelines/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/timelines/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        UpdateTLEntry body = ; // UpdateTLEntry | Update timeline data
        Long id = 789; // Long | Id of timeline to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTimeline(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#editTimeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        UpdateTLEntry body = ; // UpdateTLEntry | Update timeline data
        Long id = 789; // Long | Id of timeline to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTimeline(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#editTimeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateTLEntry *body = ; // Update timeline data
Long *id = 789; // Id of timeline to update data
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Edit timeline
[apiInstance editTimelineWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var body = ; // {{UpdateTLEntry}} Update timeline data
var id = 789; // {{Long}} Id of timeline to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editTimeline(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editTimelineExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var body = new UpdateTLEntry(); // UpdateTLEntry | Update timeline data
            var id = 789;  // Long | Id of timeline to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit timeline
                apiInstance.editTimeline(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.editTimeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$body = ; // UpdateTLEntry | Update timeline data
$id = 789; // Long | Id of timeline to update data
$project = 789; // Long | Project id

try {
    $api_instance->editTimeline($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->editTimeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateTLEntry->new(); # UpdateTLEntry | Update timeline data
my $id = 789; # Long | Id of timeline to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editTimeline(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->editTimeline: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
body =  # UpdateTLEntry | Update timeline data
id = 789 # Long | Id of timeline to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit timeline
    api_instance.edit_timeline(body, id, project=project)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->editTimeline: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of timeline to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editTimelineConfig

Update the configuration informations of an existing timeline


/service/timelines/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/timelines/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        UpdateTLConfigEntry body = ; // UpdateTLConfigEntry | The update configuration data
        Long id = 789; // Long | Timeline Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTimelineConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#editTimelineConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        UpdateTLConfigEntry body = ; // UpdateTLConfigEntry | The update configuration data
        Long id = 789; // Long | Timeline Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTimelineConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#editTimelineConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateTLConfigEntry *body = ; // The update configuration data
Long *id = 789; // Timeline Id
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Update the configuration informations of an existing timeline
[apiInstance editTimelineConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var body = ; // {{UpdateTLConfigEntry}} The update configuration data
var id = 789; // {{Long}} Timeline Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editTimelineConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editTimelineConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var body = new UpdateTLConfigEntry(); // UpdateTLConfigEntry | The update configuration data
            var id = 789;  // Long | Timeline Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing timeline
                apiInstance.editTimelineConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.editTimelineConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$body = ; // UpdateTLConfigEntry | The update configuration data
$id = 789; // Long | Timeline Id
$project = 789; // Long | Project id

try {
    $api_instance->editTimelineConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->editTimelineConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateTLConfigEntry->new(); # UpdateTLConfigEntry | The update configuration data
my $id = 789; # Long | Timeline Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editTimelineConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->editTimelineConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
body =  # UpdateTLConfigEntry | The update configuration data
id = 789 # Long | Timeline Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing timeline
    api_instance.edit_timeline_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->editTimelineConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Timeline Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getAllTimelines

Get a list of the available timelines


/service/timelines

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/timelines?excludeInactive=&excludePublic=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdTimeline] result = apiInstance.getAllTimelines(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getAllTimelines");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Boolean excludeInactive = true; // Boolean | Exclude inactive elements
        Boolean excludePublic = true; // Boolean | Exclude public projects
        Long project = 789; // Long | Project id
        try {
            array[HdTimeline] result = apiInstance.getAllTimelines(excludeInactive, excludePublic, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getAllTimelines");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *excludeInactive = true; // Exclude inactive elements (optional)
Boolean *excludePublic = true; // Exclude public projects (optional)
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Get a list of the available timelines
[apiInstance getAllTimelinesWith:excludeInactive
    excludePublic:excludePublic
    project:project
              completionHandler: ^(array[HdTimeline] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var opts = { 
  'excludeInactive': true, // {{Boolean}} Exclude inactive elements
  'excludePublic': true, // {{Boolean}} Exclude public projects
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllTimelines(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllTimelinesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var excludeInactive = true;  // Boolean | Exclude inactive elements (optional) 
            var excludePublic = true;  // Boolean | Exclude public projects (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a list of the available timelines
                array[HdTimeline] result = apiInstance.getAllTimelines(excludeInactive, excludePublic, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.getAllTimelines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$excludeInactive = true; // Boolean | Exclude inactive elements
$excludePublic = true; // Boolean | Exclude public projects
$project = 789; // Long | Project id

try {
    $result = $api_instance->getAllTimelines($excludeInactive, $excludePublic, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->getAllTimelines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $excludeInactive = true; # Boolean | Exclude inactive elements
my $excludePublic = true; # Boolean | Exclude public projects
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getAllTimelines(excludeInactive => $excludeInactive, excludePublic => $excludePublic, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->getAllTimelines: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
excludeInactive = true # Boolean | Exclude inactive elements (optional)
excludePublic = true # Boolean | Exclude public projects (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get a list of the available timelines
    api_response = api_instance.get_all_timelines(excludeInactive=excludeInactive, excludePublic=excludePublic, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->getAllTimelines: %s\n" % e)

Parameters

Query parameters
Name Description
excludeInactive
Boolean
Exclude inactive elements
excludePublic
Boolean
Exclude public projects
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getTimeline

Get a timeline by Id


/service/timelines/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/timelines/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | Requested timeline Id
        Long project = 789; // Long | Project id
        try {
            HdTimeline result = apiInstance.getTimeline(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getTimeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | Requested timeline Id
        Long project = 789; // Long | Project id
        try {
            HdTimeline result = apiInstance.getTimeline(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getTimeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested timeline Id
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Get a timeline by Id
[apiInstance getTimelineWith:id
    project:project
              completionHandler: ^(HdTimeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var id = 789; // {{Long}} Requested timeline Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTimeline(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTimelineExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var id = 789;  // Long | Requested timeline Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a timeline by Id
                HdTimeline result = apiInstance.getTimeline(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.getTimeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$id = 789; // Long | Requested timeline Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getTimeline($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->getTimeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $id = 789; # Long | Requested timeline Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getTimeline(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->getTimeline: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
id = 789 # Long | Requested timeline Id
project = 789 # Long | Project id (optional)

try: 
    # Get a timeline by Id
    api_response = api_instance.get_timeline(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->getTimeline: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested timeline Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getTimelineConfig

Get the configuration informations of an existing timeline


/service/timelines/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/timelines/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | HdTimeline Id
        Long project = 789; // Long | Project id
        try {
            TLConfig result = apiInstance.getTimelineConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getTimelineConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long id = 789; // Long | HdTimeline Id
        Long project = 789; // Long | Project id
        try {
            TLConfig result = apiInstance.getTimelineConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getTimelineConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdTimeline Id
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Get the configuration informations of an existing timeline
[apiInstance getTimelineConfigWith:id
    project:project
              completionHandler: ^(TLConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var id = 789; // {{Long}} HdTimeline Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTimelineConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTimelineConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var id = 789;  // Long | HdTimeline Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing timeline
                TLConfig result = apiInstance.getTimelineConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.getTimelineConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$id = 789; // Long | HdTimeline Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getTimelineConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->getTimelineConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $id = 789; # Long | HdTimeline Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getTimelineConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->getTimelineConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
id = 789 # Long | HdTimeline Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing timeline
    api_response = api_instance.get_timeline_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->getTimelineConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdTimeline Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getTimelineElementsForMove

Get timelines linked element for move/copy


/service/timelines/linked_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/timelines/linked_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | TimeLine ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getTimelineElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getTimelineElementsForMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | TimeLine ID
        Long project = 789; // Long | Project id
        try {
            array[DcUsedElement] result = apiInstance.getTimelineElementsForMove(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#getTimelineElementsForMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // TimeLine ID (optional)
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Get timelines linked element for move/copy
[apiInstance getTimelineElementsForMoveWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(array[DcUsedElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} TimeLine ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTimelineElementsForMove(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTimelineElementsForMoveExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | TimeLine ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get timelines linked element for move/copy
                array[DcUsedElement] result = apiInstance.getTimelineElementsForMove(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.getTimelineElementsForMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | TimeLine ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->getTimelineElementsForMove($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->getTimelineElementsForMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | TimeLine ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getTimelineElementsForMove(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->getTimelineElementsForMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | TimeLine ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get timelines linked element for move/copy
    api_response = api_instance.get_timeline_elements_for_move(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->getTimelineElementsForMove: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
TimeLine ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveTimelineElements

Move timelines and linked elements to another project


/service/timelines/move_elements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/timelines/move_elements?destProject=&elmsIds=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeLineControllerApi;

import java.io.File;
import java.util.*;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | TimeLine ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveTimelineElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#moveTimelineElements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeLineControllerApi;

public class TimeLineControllerApiExample {

    public static void main(String[] args) {
        TimeLineControllerApi apiInstance = new TimeLineControllerApi();
        Long destProject = 789; // Long | destProject
        array[Long] elmsIds = ; // array[Long] | TimeLine ID
        Long project = 789; // Long | Project id
        try {
            DcMoveResponse result = apiInstance.moveTimelineElements(destProject, elmsIds, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeLineControllerApi#moveTimelineElements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *destProject = 789; // destProject
array[Long] *elmsIds = ; // TimeLine ID (optional)
Long *project = 789; // Project id (optional)

TimeLineControllerApi *apiInstance = [[TimeLineControllerApi alloc] init];

// Move timelines and linked elements to another project
[apiInstance moveTimelineElementsWith:destProject
    elmsIds:elmsIds
    project:project
              completionHandler: ^(DcMoveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimeLineControllerApi()
var destProject = 789; // {{Long}} destProject
var opts = { 
  'elmsIds': , // {{array[Long]}} TimeLine ID
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveTimelineElements(destProject, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveTimelineElementsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeLineControllerApi();
            var destProject = 789;  // Long | destProject
            var elmsIds = new array[Long](); // array[Long] | TimeLine ID (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Move timelines and linked elements to another project
                DcMoveResponse result = apiInstance.moveTimelineElements(destProject, elmsIds, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeLineControllerApi.moveTimelineElements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeLineControllerApi();
$destProject = 789; // Long | destProject
$elmsIds = ; // array[Long] | TimeLine ID
$project = 789; // Long | Project id

try {
    $result = $api_instance->moveTimelineElements($destProject, $elmsIds, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimeLineControllerApi->moveTimelineElements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeLineControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeLineControllerApi->new();
my $destProject = 789; # Long | destProject
my $elmsIds = []; # array[Long] | TimeLine ID
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->moveTimelineElements(destProject => $destProject, elmsIds => $elmsIds, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimeLineControllerApi->moveTimelineElements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeLineControllerApi()
destProject = 789 # Long | destProject
elmsIds =  # array[Long] | TimeLine ID (optional)
project = 789 # Long | Project id (optional)

try: 
    # Move timelines and linked elements to another project
    api_response = api_instance.move_timeline_elements(destProject, elmsIds=elmsIds, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeLineControllerApi->moveTimelineElements: %s\n" % e)

Parameters

Query parameters
Name Description
destProject*
Long (int64)
destProject
Required
elmsIds
array[Long] (int64)
TimeLine ID
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


TimezoneController

getDefaultTimezone

Get default instance timezone


/service/dates/timezone/default

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/dates/timezone/default"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimezoneControllerApi;

import java.io.File;
import java.util.*;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        try {
            'String' result = apiInstance.getDefaultTimezone();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#getDefaultTimezone");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimezoneControllerApi;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        try {
            'String' result = apiInstance.getDefaultTimezone();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#getDefaultTimezone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

TimezoneControllerApi *apiInstance = [[TimezoneControllerApi alloc] init];

// Get default instance timezone
[apiInstance getDefaultTimezoneWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimezoneControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefaultTimezone(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDefaultTimezoneExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimezoneControllerApi();

            try
            {
                // Get default instance timezone
                'String' result = apiInstance.getDefaultTimezone();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimezoneControllerApi.getDefaultTimezone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimezoneControllerApi();

try {
    $result = $api_instance->getDefaultTimezone();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimezoneControllerApi->getDefaultTimezone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimezoneControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimezoneControllerApi->new();

eval { 
    my $result = $api_instance->getDefaultTimezone();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimezoneControllerApi->getDefaultTimezone: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimezoneControllerApi()

try: 
    # Get default instance timezone
    api_response = api_instance.get_default_timezone()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimezoneControllerApi->getDefaultTimezone: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getServerTimezone

Get server timezone


/service/dates/timezone/servers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dates/timezone/servers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimezoneControllerApi;

import java.io.File;
import java.util.*;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        try {
            TimeZone result = apiInstance.getServerTimezone();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#getServerTimezone");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimezoneControllerApi;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        try {
            TimeZone result = apiInstance.getServerTimezone();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#getServerTimezone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

TimezoneControllerApi *apiInstance = [[TimezoneControllerApi alloc] init];

// Get server timezone
[apiInstance getServerTimezoneWithCompletionHandler: 
              ^(TimeZone output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimezoneControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServerTimezone(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getServerTimezoneExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimezoneControllerApi();

            try
            {
                // Get server timezone
                TimeZone result = apiInstance.getServerTimezone();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimezoneControllerApi.getServerTimezone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimezoneControllerApi();

try {
    $result = $api_instance->getServerTimezone();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimezoneControllerApi->getServerTimezone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimezoneControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimezoneControllerApi->new();

eval { 
    my $result = $api_instance->getServerTimezone();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimezoneControllerApi->getServerTimezone: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimezoneControllerApi()

try: 
    # Get server timezone
    api_response = api_instance.get_server_timezone()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimezoneControllerApi->getServerTimezone: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listLanguage

Get availables language


/service/dates/languages

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dates/languages?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimezoneControllerApi;

import java.io.File;
import java.util.*;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[LabelValue] result = apiInstance.listLanguage(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#listLanguage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimezoneControllerApi;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[LabelValue] result = apiInstance.listLanguage(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#listLanguage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

TimezoneControllerApi *apiInstance = [[TimezoneControllerApi alloc] init];

// Get availables language
[apiInstance listLanguageWith:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[LabelValue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimezoneControllerApi()
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listLanguage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listLanguageExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimezoneControllerApi();
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Get availables language
                array[LabelValue] result = apiInstance.listLanguage(iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimezoneControllerApi.listLanguage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimezoneControllerApi();
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->listLanguage($iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimezoneControllerApi->listLanguage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimezoneControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimezoneControllerApi->new();
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->listLanguage(iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimezoneControllerApi->listLanguage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimezoneControllerApi()
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Get availables language
    api_response = api_instance.list_language(iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimezoneControllerApi->listLanguage: %s\n" % e)

Parameters

Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


listTimezones

Get availables timezones


/service/dates/timezones

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/dates/timezones"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimezoneControllerApi;

import java.io.File;
import java.util.*;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        try {
            array['String'] result = apiInstance.listTimezones();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#listTimezones");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimezoneControllerApi;

public class TimezoneControllerApiExample {

    public static void main(String[] args) {
        TimezoneControllerApi apiInstance = new TimezoneControllerApi();
        try {
            array['String'] result = apiInstance.listTimezones();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimezoneControllerApi#listTimezones");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

TimezoneControllerApi *apiInstance = [[TimezoneControllerApi alloc] init];

// Get availables timezones
[apiInstance listTimezonesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TimezoneControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listTimezones(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listTimezonesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimezoneControllerApi();

            try
            {
                // Get availables timezones
                array['String'] result = apiInstance.listTimezones();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimezoneControllerApi.listTimezones: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimezoneControllerApi();

try {
    $result = $api_instance->listTimezones();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TimezoneControllerApi->listTimezones: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimezoneControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimezoneControllerApi->new();

eval { 
    my $result = $api_instance->listTimezones();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TimezoneControllerApi->listTimezones: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimezoneControllerApi()

try: 
    # Get availables timezones
    api_response = api_instance.list_timezones()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimezoneControllerApi->listTimezones: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


TreemapChartController

checkConfigUsingGET16

Check the configuration informations of an existing chart


/service/charts/treemap/{id}/check_config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/treemap/{id}/check_config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET16(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#checkConfigUsingGET16");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            'Boolean' result = apiInstance.checkConfigUsingGET16(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#checkConfigUsingGET16");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Check the configuration informations of an existing chart
[apiInstance checkConfigUsingGET16With:id
    project:project
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkConfigUsingGET16(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkConfigUsingGET16Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Check the configuration informations of an existing chart
                'Boolean' result = apiInstance.checkConfigUsingGET16(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.checkConfigUsingGET16: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->checkConfigUsingGET16($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->checkConfigUsingGET16: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->checkConfigUsingGET16(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->checkConfigUsingGET16: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Check the configuration informations of an existing chart
    api_response = api_instance.check_config_using_get16(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->checkConfigUsingGET16: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createTreemapChart

Create a new chart

Create a new chart and returns the new generated id


/service/charts/treemap

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/treemap?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTreemapChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#createTreemapChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        CreateChartEntry body = ; // CreateChartEntry | chart
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTreemapChart(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#createTreemapChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartEntry *body = ; // chart
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Create a new chart
[apiInstance createTreemapChartWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var body = ; // {{CreateChartEntry}} chart
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTreemapChart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTreemapChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var body = new CreateChartEntry(); // CreateChartEntry | chart
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart
                Long result = apiInstance.createTreemapChart(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.createTreemapChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$body = ; // CreateChartEntry | chart
$project = 789; // Long | Project id

try {
    $result = $api_instance->createTreemapChart($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->createTreemapChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartEntry->new(); # CreateChartEntry | chart
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createTreemapChart(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->createTreemapChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
body =  # CreateChartEntry | chart
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart
    api_response = api_instance.create_treemap_chart(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->createTreemapChart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createTreemapChartFromDb

Create a new chart from datablock

Create a new chart from datablock and returns the new generated id


/service/charts/treemap/from_db

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/treemap/from_db?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTreemapChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#createTreemapChartFromDb");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        CreateChartFromDbEntry body = ; // CreateChartFromDbEntry | the new chart data
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.createTreemapChartFromDb(body, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#createTreemapChartFromDb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CreateChartFromDbEntry *body = ; // the new chart data
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Create a new chart from datablock
[apiInstance createTreemapChartFromDbWith:body
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var body = ; // {{CreateChartFromDbEntry}} the new chart data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTreemapChartFromDb(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTreemapChartFromDbExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var body = new CreateChartFromDbEntry(); // CreateChartFromDbEntry | the new chart data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Create a new chart from datablock
                Long result = apiInstance.createTreemapChartFromDb(body, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.createTreemapChartFromDb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$body = ; // CreateChartFromDbEntry | the new chart data
$project = 789; // Long | Project id

try {
    $result = $api_instance->createTreemapChartFromDb($body, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->createTreemapChartFromDb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateChartFromDbEntry->new(); # CreateChartFromDbEntry | the new chart data
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createTreemapChartFromDb(body => $body, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->createTreemapChartFromDb: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
body =  # CreateChartFromDbEntry | the new chart data
project = 789 # Long | Project id (optional)

try: 
    # Create a new chart from datablock
    api_response = api_instance.create_treemap_chart_from_db(body, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->createTreemapChartFromDb: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteTreemapChart

Delete an existing chart


/service/charts/treemap/{id}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/charts/treemap/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteTreemapChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#deleteTreemapChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be deleted
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteTreemapChart(id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#deleteTreemapChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be deleted
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Delete an existing chart
[apiInstance deleteTreemapChartWith:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be deleted
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTreemapChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTreemapChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be deleted
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Delete an existing chart
                apiInstance.deleteTreemapChart(id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.deleteTreemapChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$id = 789; // Long | The Id of the chart to be deleted
$project = 789; // Long | Project id

try {
    $api_instance->deleteTreemapChart($id, $project);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->deleteTreemapChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be deleted
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteTreemapChart(id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->deleteTreemapChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
id = 789 # Long | The Id of the chart to be deleted
project = 789 # Long | Project id (optional)

try: 
    # Delete an existing chart
    api_instance.delete_treemap_chart(id, project=project)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->deleteTreemapChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be deleted
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


duplicateTreemapChart

Duplicate an existing chart


/service/charts/treemap/{id}/duplicate

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/charts/treemap/{id}/duplicate?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateTreemapChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#duplicateTreemapChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | The Id of the chart to be duplicated
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            Long result = apiInstance.duplicateTreemapChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#duplicateTreemapChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // The Id of the chart to be duplicated
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Duplicate an existing chart
[apiInstance duplicateTreemapChartWith:id
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var id = 789; // {{Long}} The Id of the chart to be duplicated
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateTreemapChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class duplicateTreemapChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var id = 789;  // Long | The Id of the chart to be duplicated
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // Duplicate an existing chart
                Long result = apiInstance.duplicateTreemapChart(id, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.duplicateTreemapChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$id = 789; // Long | The Id of the chart to be duplicated
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->duplicateTreemapChart($id, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->duplicateTreemapChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $id = 789; # Long | The Id of the chart to be duplicated
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->duplicateTreemapChart(id => $id, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->duplicateTreemapChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
id = 789 # Long | The Id of the chart to be duplicated
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # Duplicate an existing chart
    api_response = api_instance.duplicate_treemap_chart(id, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->duplicateTreemapChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
The Id of the chart to be duplicated
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editTreemapChart

Edit chart

Edit an existing chart


/service/charts/treemap/{id}

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/treemap/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTreemapChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#editTreemapChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        UpdateChartEntry body = ; // UpdateChartEntry | Update chart data
        Long id = 789; // Long | Id of chart to update data
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTreemapChart(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#editTreemapChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateChartEntry *body = ; // Update chart data
Long *id = 789; // Id of chart to update data
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Edit chart
[apiInstance editTreemapChartWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var body = ; // {{UpdateChartEntry}} Update chart data
var id = 789; // {{Long}} Id of chart to update data
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editTreemapChart(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editTreemapChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var body = new UpdateChartEntry(); // UpdateChartEntry | Update chart data
            var id = 789;  // Long | Id of chart to update data
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Edit chart
                apiInstance.editTreemapChart(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.editTreemapChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$body = ; // UpdateChartEntry | Update chart data
$id = 789; // Long | Id of chart to update data
$project = 789; // Long | Project id

try {
    $api_instance->editTreemapChart($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->editTreemapChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChartEntry->new(); # UpdateChartEntry | Update chart data
my $id = 789; # Long | Id of chart to update data
my $project = 789; # Long | Project id

eval { 
    $api_instance->editTreemapChart(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->editTreemapChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
body =  # UpdateChartEntry | Update chart data
id = 789 # Long | Id of chart to update data
project = 789 # Long | Project id (optional)

try: 
    # Edit chart
    api_instance.edit_treemap_chart(body, id, project=project)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->editTreemapChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Id of chart to update data
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editTreemapChartConfig

Update the configuration informations of an existing chart


/service/charts/treemap/{id}/config

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/charts/treemap/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        UpdateTreemapChartConfigEntry body = ; // UpdateTreemapChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTreemapChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#editTreemapChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        UpdateTreemapChartConfigEntry body = ; // UpdateTreemapChartConfigEntry | The update configuration data
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            apiInstance.editTreemapChartConfig(body, id, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#editTreemapChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateTreemapChartConfigEntry *body = ; // The update configuration data
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Update the configuration informations of an existing chart
[apiInstance editTreemapChartConfigWith:body
    id:id
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var body = ; // {{UpdateTreemapChartConfigEntry}} The update configuration data
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editTreemapChartConfig(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editTreemapChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var body = new UpdateTreemapChartConfigEntry(); // UpdateTreemapChartConfigEntry | The update configuration data
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Update the configuration informations of an existing chart
                apiInstance.editTreemapChartConfig(body, id, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.editTreemapChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$body = ; // UpdateTreemapChartConfigEntry | The update configuration data
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $api_instance->editTreemapChartConfig($body, $id, $project);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->editTreemapChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $body = WWW::SwaggerClient::Object::UpdateTreemapChartConfigEntry->new(); # UpdateTreemapChartConfigEntry | The update configuration data
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    $api_instance->editTreemapChartConfig(body => $body, id => $id, project => $project);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->editTreemapChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
body =  # UpdateTreemapChartConfigEntry | The update configuration data
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Update the configuration informations of an existing chart
    api_instance.edit_treemap_chart_config(body, id, project=project)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->editTreemapChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


getTreemapChart

Get a chart by Id


/service/charts/treemap/{id}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/treemap/{id}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getTreemapChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#getTreemapChart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | Requested chart Id
        Long project = 789; // Long | Project id
        try {
            HdChart result = apiInstance.getTreemapChart(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#getTreemapChart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Requested chart Id
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Get a chart by Id
[apiInstance getTreemapChartWith:id
    project:project
              completionHandler: ^(HdChart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var id = 789; // {{Long}} Requested chart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTreemapChart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTreemapChartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var id = 789;  // Long | Requested chart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get a chart by Id
                HdChart result = apiInstance.getTreemapChart(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.getTreemapChart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$id = 789; // Long | Requested chart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getTreemapChart($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->getTreemapChart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $id = 789; # Long | Requested chart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getTreemapChart(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->getTreemapChart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
id = 789 # Long | Requested chart Id
project = 789 # Long | Project id (optional)

try: 
    # Get a chart by Id
    api_response = api_instance.get_treemap_chart(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->getTreemapChart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Requested chart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getTreemapChartConfig

Get the configuration informations of an existing chart


/service/charts/treemap/{id}/config

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/charts/treemap/{id}/config?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TreemapChartControllerApi;

import java.io.File;
import java.util.*;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            TreemapChartConfig result = apiInstance.getTreemapChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#getTreemapChartConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TreemapChartControllerApi;

public class TreemapChartControllerApiExample {

    public static void main(String[] args) {
        TreemapChartControllerApi apiInstance = new TreemapChartControllerApi();
        Long id = 789; // Long | HdChart Id
        Long project = 789; // Long | Project id
        try {
            TreemapChartConfig result = apiInstance.getTreemapChartConfig(id, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TreemapChartControllerApi#getTreemapChartConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // HdChart Id
Long *project = 789; // Project id (optional)

TreemapChartControllerApi *apiInstance = [[TreemapChartControllerApi alloc] init];

// Get the configuration informations of an existing chart
[apiInstance getTreemapChartConfigWith:id
    project:project
              completionHandler: ^(TreemapChartConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.TreemapChartControllerApi()
var id = 789; // {{Long}} HdChart Id
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTreemapChartConfig(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTreemapChartConfigExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TreemapChartControllerApi();
            var id = 789;  // Long | HdChart Id
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get the configuration informations of an existing chart
                TreemapChartConfig result = apiInstance.getTreemapChartConfig(id, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TreemapChartControllerApi.getTreemapChartConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTreemapChartControllerApi();
$id = 789; // Long | HdChart Id
$project = 789; // Long | Project id

try {
    $result = $api_instance->getTreemapChartConfig($id, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TreemapChartControllerApi->getTreemapChartConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TreemapChartControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TreemapChartControllerApi->new();
my $id = 789; # Long | HdChart Id
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getTreemapChartConfig(id => $id, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TreemapChartControllerApi->getTreemapChartConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TreemapChartControllerApi()
id = 789 # Long | HdChart Id
project = 789 # Long | Project id (optional)

try: 
    # Get the configuration informations of an existing chart
    api_response = api_instance.get_treemap_chart_config(id, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TreemapChartControllerApi->getTreemapChartConfig: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
HdChart Id
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


UserTokenController

createExpositionAccessTokens

Create a new exposition Access Token

Create a new Exposition Access Token and returns the new created token


/service/users/exposition_tokens

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/users/exposition_tokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        ExpositionTokenRequest body = ; // ExpositionTokenRequest | New token data
        try {
            NewOfflineAccessToken result = apiInstance.createExpositionAccessTokens(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#createExpositionAccessTokens");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        ExpositionTokenRequest body = ; // ExpositionTokenRequest | New token data
        try {
            NewOfflineAccessToken result = apiInstance.createExpositionAccessTokens(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#createExpositionAccessTokens");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExpositionTokenRequest *body = ; // New token data

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Create a new exposition Access Token
[apiInstance createExpositionAccessTokensWith:body
              completionHandler: ^(NewOfflineAccessToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var body = ; // {{ExpositionTokenRequest}} New token data

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExpositionAccessTokens(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExpositionAccessTokensExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();
            var body = new ExpositionTokenRequest(); // ExpositionTokenRequest | New token data

            try
            {
                // Create a new exposition Access Token
                NewOfflineAccessToken result = apiInstance.createExpositionAccessTokens(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.createExpositionAccessTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();
$body = ; // ExpositionTokenRequest | New token data

try {
    $result = $api_instance->createExpositionAccessTokens($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->createExpositionAccessTokens: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExpositionTokenRequest->new(); # ExpositionTokenRequest | New token data

eval { 
    my $result = $api_instance->createExpositionAccessTokens(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->createExpositionAccessTokens: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()
body =  # ExpositionTokenRequest | New token data

try: 
    # Create a new exposition Access Token
    api_response = api_instance.create_exposition_access_tokens(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->createExpositionAccessTokens: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createOfflineTokens

Create a new Offline Token

Create a new offline and returns the new created token


/service/users/tokens

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/users/tokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        ClientTokenRequest body = ; // ClientTokenRequest | New token data
        try {
            NewOfflineAccessToken result = apiInstance.createOfflineTokens(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#createOfflineTokens");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        ClientTokenRequest body = ; // ClientTokenRequest | New token data
        try {
            NewOfflineAccessToken result = apiInstance.createOfflineTokens(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#createOfflineTokens");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ClientTokenRequest *body = ; // New token data

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Create a new Offline Token
[apiInstance createOfflineTokensWith:body
              completionHandler: ^(NewOfflineAccessToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var body = ; // {{ClientTokenRequest}} New token data

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOfflineTokens(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createOfflineTokensExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();
            var body = new ClientTokenRequest(); // ClientTokenRequest | New token data

            try
            {
                // Create a new Offline Token
                NewOfflineAccessToken result = apiInstance.createOfflineTokens(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.createOfflineTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();
$body = ; // ClientTokenRequest | New token data

try {
    $result = $api_instance->createOfflineTokens($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->createOfflineTokens: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();
my $body = WWW::SwaggerClient::Object::ClientTokenRequest->new(); # ClientTokenRequest | New token data

eval { 
    my $result = $api_instance->createOfflineTokens(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->createOfflineTokens: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()
body =  # ClientTokenRequest | New token data

try: 
    # Create a new Offline Token
    api_response = api_instance.create_offline_tokens(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->createOfflineTokens: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteOneToken

Delete One Token

Delete one Tokens


/service/users/tokens/{id}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/users/tokens/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        String id = id_example; // String | id
        try {
            ApiAccessToken result = apiInstance.deleteOneToken(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#deleteOneToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        String id = id_example; // String | id
        try {
            ApiAccessToken result = apiInstance.deleteOneToken(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#deleteOneToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // id

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Delete One Token
[apiInstance deleteOneTokenWith:id
              completionHandler: ^(ApiAccessToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var id = id_example; // {{String}} id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteOneToken(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteOneTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();
            var id = id_example;  // String | id

            try
            {
                // Delete One Token
                ApiAccessToken result = apiInstance.deleteOneToken(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.deleteOneToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();
$id = id_example; // String | id

try {
    $result = $api_instance->deleteOneToken($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->deleteOneToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();
my $id = id_example; # String | id

eval { 
    my $result = $api_instance->deleteOneToken(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->deleteOneToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()
id = id_example # String | id

try: 
    # Delete One Token
    api_response = api_instance.delete_one_token(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->deleteOneToken: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
id
Required

Responses

Status: 200 - OK


deleteTokens

Delete all Tokens

Delete all Tokens


/service/users/tokens

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/users/tokens?clientId=&offline="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        String clientId = clientId_example; // String | clientId
        Boolean offline = true; // Boolean | offline
        try {
            ApiAccessToken result = apiInstance.deleteTokens(clientId, offline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#deleteTokens");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        String clientId = clientId_example; // String | clientId
        Boolean offline = true; // Boolean | offline
        try {
            ApiAccessToken result = apiInstance.deleteTokens(clientId, offline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#deleteTokens");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *clientId = clientId_example; // clientId
Boolean *offline = true; // offline (optional)

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Delete all Tokens
[apiInstance deleteTokensWith:clientId
    offline:offline
              completionHandler: ^(ApiAccessToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var clientId = clientId_example; // {{String}} clientId
var opts = { 
  'offline': true // {{Boolean}} offline
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteTokens(clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTokensExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();
            var clientId = clientId_example;  // String | clientId
            var offline = true;  // Boolean | offline (optional) 

            try
            {
                // Delete all Tokens
                ApiAccessToken result = apiInstance.deleteTokens(clientId, offline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.deleteTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();
$clientId = clientId_example; // String | clientId
$offline = true; // Boolean | offline

try {
    $result = $api_instance->deleteTokens($clientId, $offline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->deleteTokens: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();
my $clientId = clientId_example; # String | clientId
my $offline = true; # Boolean | offline

eval { 
    my $result = $api_instance->deleteTokens(clientId => $clientId, offline => $offline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->deleteTokens: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()
clientId = clientId_example # String | clientId
offline = true # Boolean | offline (optional)

try: 
    # Delete all Tokens
    api_response = api_instance.delete_tokens(clientId, offline=offline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->deleteTokens: %s\n" % e)

Parameters

Query parameters
Name Description
clientId*
String
clientId
Required
offline
Boolean
offline

Responses

Status: 200 - OK


getAllClients

Get all clients

Get all clients


/service/users/clients

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/users/clients"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        try {
            array[Object] result = apiInstance.getAllClients();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#getAllClients");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        try {
            array[Object] result = apiInstance.getAllClients();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#getAllClients");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Get all clients
[apiInstance getAllClientsWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllClients(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllClientsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();

            try
            {
                // Get all clients
                array[Object] result = apiInstance.getAllClients();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.getAllClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();

try {
    $result = $api_instance->getAllClients();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->getAllClients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();

eval { 
    my $result = $api_instance->getAllClients();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->getAllClients: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()

try: 
    # Get all clients
    api_response = api_instance.get_all_clients()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->getAllClients: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getExpositionAccessTokens

Get all exposition access token of user

Get all exposition access token of user


/service/users/exposition_tokens

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/users/exposition_tokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        try {
            array[Object] result = apiInstance.getExpositionAccessTokens();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#getExpositionAccessTokens");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        try {
            array[Object] result = apiInstance.getExpositionAccessTokens();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#getExpositionAccessTokens");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Get all exposition access token of user
[apiInstance getExpositionAccessTokensWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExpositionAccessTokens(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExpositionAccessTokensExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();

            try
            {
                // Get all exposition access token of user
                array[Object] result = apiInstance.getExpositionAccessTokens();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.getExpositionAccessTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();

try {
    $result = $api_instance->getExpositionAccessTokens();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->getExpositionAccessTokens: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();

eval { 
    my $result = $api_instance->getExpositionAccessTokens();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->getExpositionAccessTokens: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()

try: 
    # Get all exposition access token of user
    api_response = api_instance.get_exposition_access_tokens()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->getExpositionAccessTokens: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getOfflineTokens

Get all offline token of user

Get all offline token of user


/service/users/tokens

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/users/tokens?clientId=&offline="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTokenControllerApi;

import java.io.File;
import java.util.*;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        String clientId = clientId_example; // String | clientId
        Boolean offline = true; // Boolean | offline
        try {
            array[Object] result = apiInstance.getOfflineTokens(clientId, offline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#getOfflineTokens");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserTokenControllerApi;

public class UserTokenControllerApiExample {

    public static void main(String[] args) {
        UserTokenControllerApi apiInstance = new UserTokenControllerApi();
        String clientId = clientId_example; // String | clientId
        Boolean offline = true; // Boolean | offline
        try {
            array[Object] result = apiInstance.getOfflineTokens(clientId, offline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserTokenControllerApi#getOfflineTokens");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *clientId = clientId_example; // clientId
Boolean *offline = true; // offline (optional)

UserTokenControllerApi *apiInstance = [[UserTokenControllerApi alloc] init];

// Get all offline token of user
[apiInstance getOfflineTokensWith:clientId
    offline:offline
              completionHandler: ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.UserTokenControllerApi()
var clientId = clientId_example; // {{String}} clientId
var opts = { 
  'offline': true // {{Boolean}} offline
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOfflineTokens(clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOfflineTokensExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserTokenControllerApi();
            var clientId = clientId_example;  // String | clientId
            var offline = true;  // Boolean | offline (optional) 

            try
            {
                // Get all offline token of user
                array[Object] result = apiInstance.getOfflineTokens(clientId, offline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserTokenControllerApi.getOfflineTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserTokenControllerApi();
$clientId = clientId_example; // String | clientId
$offline = true; // Boolean | offline

try {
    $result = $api_instance->getOfflineTokens($clientId, $offline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserTokenControllerApi->getOfflineTokens: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTokenControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserTokenControllerApi->new();
my $clientId = clientId_example; # String | clientId
my $offline = true; # Boolean | offline

eval { 
    my $result = $api_instance->getOfflineTokens(clientId => $clientId, offline => $offline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserTokenControllerApi->getOfflineTokens: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserTokenControllerApi()
clientId = clientId_example # String | clientId
offline = true # Boolean | offline (optional)

try: 
    # Get all offline token of user
    api_response = api_instance.get_offline_tokens(clientId, offline=offline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserTokenControllerApi->getOfflineTokens: %s\n" % e)

Parameters

Query parameters
Name Description
clientId*
String
clientId
Required
offline
Boolean
offline

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


ValueSearchController

execValueSearchByRules

Exec Value Search by rules


/service/value_search/advanced/exec

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/value_search/advanced/exec?clientId=&ctx=&entite_type=&multicolumnMode=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ValueSearchControllerApi;

import java.io.File;
import java.util.*;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        Rule body = ; // Rule | rules
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        String entiteType = entiteType_example; // String | entite_type
        String multicolumnMode = multicolumnMode_example; // String | multicolumnMode
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execValueSearchByRules(body, clientId, ctx, entiteType, multicolumnMode, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#execValueSearchByRules");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ValueSearchControllerApi;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        Rule body = ; // Rule | rules
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        String entiteType = entiteType_example; // String | entite_type
        String multicolumnMode = multicolumnMode_example; // String | multicolumnMode
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execValueSearchByRules(body, clientId, ctx, entiteType, multicolumnMode, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#execValueSearchByRules");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Rule *body = ; // rules
String *clientId = clientId_example; // clientId (optional)
Integer *ctx = 56; // ctx (optional)
String *entiteType = entiteType_example; // entite_type (optional)
String *multicolumnMode = multicolumnMode_example; // multicolumnMode (optional)
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

ValueSearchControllerApi *apiInstance = [[ValueSearchControllerApi alloc] init];

// Exec Value Search by rules
[apiInstance execValueSearchByRulesWith:body
    clientId:clientId
    ctx:ctx
    entiteType:entiteType
    multicolumnMode:multicolumnMode
    project:project
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ValueSearchControllerApi()
var body = ; // {{Rule}} rules
var opts = { 
  'clientId': clientId_example // {{String}} clientId
  'ctx': 56 // {{Integer}} ctx
  'entiteType': entiteType_example // {{String}} entite_type
  'multicolumnMode': multicolumnMode_example // {{String}} multicolumnMode
  'project': 789 // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.execValueSearchByRules(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class execValueSearchByRulesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ValueSearchControllerApi();
            var body = new Rule(); // Rule | rules
            var clientId = clientId_example;  // String | clientId (optional) 
            var ctx = 56;  // Integer | ctx (optional) 
            var entiteType = entiteType_example;  // String | entite_type (optional) 
            var multicolumnMode = multicolumnMode_example;  // String | multicolumnMode (optional) 
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Exec Value Search by rules
                JobKeyResponse result = apiInstance.execValueSearchByRules(body, clientId, ctx, entiteType, multicolumnMode, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ValueSearchControllerApi.execValueSearchByRules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiValueSearchControllerApi();
$body = ; // Rule | rules
$clientId = clientId_example; // String | clientId
$ctx = 56; // Integer | ctx
$entiteType = entiteType_example; // String | entite_type
$multicolumnMode = multicolumnMode_example; // String | multicolumnMode
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->execValueSearchByRules($body, $clientId, $ctx, $entiteType, $multicolumnMode, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValueSearchControllerApi->execValueSearchByRules: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ValueSearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ValueSearchControllerApi->new();
my $body = WWW::SwaggerClient::Object::Rule->new(); # Rule | rules
my $clientId = clientId_example; # String | clientId
my $ctx = 56; # Integer | ctx
my $entiteType = entiteType_example; # String | entite_type
my $multicolumnMode = multicolumnMode_example; # String | multicolumnMode
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->execValueSearchByRules(body => $body, clientId => $clientId, ctx => $ctx, entiteType => $entiteType, multicolumnMode => $multicolumnMode, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ValueSearchControllerApi->execValueSearchByRules: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ValueSearchControllerApi()
body =  # Rule | rules
clientId = clientId_example # String | clientId (optional)
ctx = 56 # Integer | ctx (optional)
entiteType = entiteType_example # String | entite_type (optional)
multicolumnMode = multicolumnMode_example # String | multicolumnMode (optional)
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Exec Value Search by rules
    api_response = api_instance.exec_value_search_by_rules(body, clientId=clientId, ctx=ctx, entiteType=entiteType, multicolumnMode=multicolumnMode, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ValueSearchControllerApi->execValueSearchByRules: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
clientId
String
clientId
ctx
Integer (int32)
ctx
entite_type
String
entite_type
multicolumnMode
String
multicolumnMode
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


execValueSearchByText

Exec Value Search by text


/service/value_search/basic/exec

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/value_search/basic/exec?clientId=&ctx=&entite_type=&ignoreCase=&multicolumnMode=&project=&text=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ValueSearchControllerApi;

import java.io.File;
import java.util.*;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        String entiteType = entiteType_example; // String | entite_type
        Boolean ignoreCase = true; // Boolean | ignoreCase
        String multicolumnMode = multicolumnMode_example; // String | multicolumnMode
        Long project = 789; // Long | Project id
        String text = text_example; // String | text
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execValueSearchByText(clientId, ctx, entiteType, ignoreCase, multicolumnMode, project, text, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#execValueSearchByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ValueSearchControllerApi;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        String clientId = clientId_example; // String | clientId
        Integer ctx = 56; // Integer | ctx
        String entiteType = entiteType_example; // String | entite_type
        Boolean ignoreCase = true; // Boolean | ignoreCase
        String multicolumnMode = multicolumnMode_example; // String | multicolumnMode
        Long project = 789; // Long | Project id
        String text = text_example; // String | text
        Boolean useCache = true; // Boolean | useCache
        try {
            JobKeyResponse result = apiInstance.execValueSearchByText(clientId, ctx, entiteType, ignoreCase, multicolumnMode, project, text, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#execValueSearchByText");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *clientId = clientId_example; // clientId (optional)
Integer *ctx = 56; // ctx (optional)
String *entiteType = entiteType_example; // entite_type (optional)
Boolean *ignoreCase = true; // ignoreCase (optional)
String *multicolumnMode = multicolumnMode_example; // multicolumnMode (optional)
Long *project = 789; // Project id (optional)
String *text = text_example; // text (optional)
Boolean *useCache = true; // useCache (optional)

ValueSearchControllerApi *apiInstance = [[ValueSearchControllerApi alloc] init];

// Exec Value Search by text
[apiInstance execValueSearchByTextWith:clientId
    ctx:ctx
    entiteType:entiteType
    ignoreCase:ignoreCase
    multicolumnMode:multicolumnMode
    project:project
    text:text
    useCache:useCache
              completionHandler: ^(JobKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ValueSearchControllerApi()
var opts = { 
  'clientId': clientId_example, // {{String}} clientId
  'ctx': 56, // {{Integer}} ctx
  'entiteType': entiteType_example, // {{String}} entite_type
  'ignoreCase': true, // {{Boolean}} ignoreCase
  'multicolumnMode': multicolumnMode_example, // {{String}} multicolumnMode
  'project': 789, // {{Long}} Project id
  'text': text_example, // {{String}} text
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.execValueSearchByText(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class execValueSearchByTextExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ValueSearchControllerApi();
            var clientId = clientId_example;  // String | clientId (optional) 
            var ctx = 56;  // Integer | ctx (optional) 
            var entiteType = entiteType_example;  // String | entite_type (optional) 
            var ignoreCase = true;  // Boolean | ignoreCase (optional) 
            var multicolumnMode = multicolumnMode_example;  // String | multicolumnMode (optional) 
            var project = 789;  // Long | Project id (optional) 
            var text = text_example;  // String | text (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Exec Value Search by text
                JobKeyResponse result = apiInstance.execValueSearchByText(clientId, ctx, entiteType, ignoreCase, multicolumnMode, project, text, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ValueSearchControllerApi.execValueSearchByText: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiValueSearchControllerApi();
$clientId = clientId_example; // String | clientId
$ctx = 56; // Integer | ctx
$entiteType = entiteType_example; // String | entite_type
$ignoreCase = true; // Boolean | ignoreCase
$multicolumnMode = multicolumnMode_example; // String | multicolumnMode
$project = 789; // Long | Project id
$text = text_example; // String | text
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->execValueSearchByText($clientId, $ctx, $entiteType, $ignoreCase, $multicolumnMode, $project, $text, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValueSearchControllerApi->execValueSearchByText: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ValueSearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ValueSearchControllerApi->new();
my $clientId = clientId_example; # String | clientId
my $ctx = 56; # Integer | ctx
my $entiteType = entiteType_example; # String | entite_type
my $ignoreCase = true; # Boolean | ignoreCase
my $multicolumnMode = multicolumnMode_example; # String | multicolumnMode
my $project = 789; # Long | Project id
my $text = text_example; # String | text
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->execValueSearchByText(clientId => $clientId, ctx => $ctx, entiteType => $entiteType, ignoreCase => $ignoreCase, multicolumnMode => $multicolumnMode, project => $project, text => $text, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ValueSearchControllerApi->execValueSearchByText: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ValueSearchControllerApi()
clientId = clientId_example # String | clientId (optional)
ctx = 56 # Integer | ctx (optional)
entiteType = entiteType_example # String | entite_type (optional)
ignoreCase = true # Boolean | ignoreCase (optional)
multicolumnMode = multicolumnMode_example # String | multicolumnMode (optional)
project = 789 # Long | Project id (optional)
text = text_example # String | text (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Exec Value Search by text
    api_response = api_instance.exec_value_search_by_text(clientId=clientId, ctx=ctx, entiteType=entiteType, ignoreCase=ignoreCase, multicolumnMode=multicolumnMode, project=project, text=text, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ValueSearchControllerApi->execValueSearchByText: %s\n" % e)

Parameters

Query parameters
Name Description
clientId
String
clientId
ctx
Integer (int32)
ctx
entite_type
String
entite_type
ignoreCase
Boolean
ignoreCase
multicolumnMode
String
multicolumnMode
project
Long (int64)
Project id
text
String
text
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getFilterByColumns

Get filters


/service/value_search/filter

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/value_search/filter?multicolumnMode=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ValueSearchControllerApi;

import java.io.File;
import java.util.*;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        BaseRequestGrammar body = ; // BaseRequestGrammar | grammar
        String multicolumnMode = multicolumnMode_example; // String | multicolumnMode
        Long project = 789; // Long | Project id
        try {
            Rule result = apiInstance.getFilterByColumns(body, multicolumnMode, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#getFilterByColumns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ValueSearchControllerApi;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        BaseRequestGrammar body = ; // BaseRequestGrammar | grammar
        String multicolumnMode = multicolumnMode_example; // String | multicolumnMode
        Long project = 789; // Long | Project id
        try {
            Rule result = apiInstance.getFilterByColumns(body, multicolumnMode, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#getFilterByColumns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
BaseRequestGrammar *body = ; // grammar
String *multicolumnMode = multicolumnMode_example; // multicolumnMode (optional)
Long *project = 789; // Project id (optional)

ValueSearchControllerApi *apiInstance = [[ValueSearchControllerApi alloc] init];

// Get filters
[apiInstance getFilterByColumnsWith:body
    multicolumnMode:multicolumnMode
    project:project
              completionHandler: ^(Rule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ValueSearchControllerApi()
var body = ; // {{BaseRequestGrammar}} grammar
var opts = { 
  'multicolumnMode': multicolumnMode_example // {{String}} multicolumnMode
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilterByColumns(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilterByColumnsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ValueSearchControllerApi();
            var body = new BaseRequestGrammar(); // BaseRequestGrammar | grammar
            var multicolumnMode = multicolumnMode_example;  // String | multicolumnMode (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get filters
                Rule result = apiInstance.getFilterByColumns(body, multicolumnMode, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ValueSearchControllerApi.getFilterByColumns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiValueSearchControllerApi();
$body = ; // BaseRequestGrammar | grammar
$multicolumnMode = multicolumnMode_example; // String | multicolumnMode
$project = 789; // Long | Project id

try {
    $result = $api_instance->getFilterByColumns($body, $multicolumnMode, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValueSearchControllerApi->getFilterByColumns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ValueSearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ValueSearchControllerApi->new();
my $body = WWW::SwaggerClient::Object::BaseRequestGrammar->new(); # BaseRequestGrammar | grammar
my $multicolumnMode = multicolumnMode_example; # String | multicolumnMode
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getFilterByColumns(body => $body, multicolumnMode => $multicolumnMode, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ValueSearchControllerApi->getFilterByColumns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ValueSearchControllerApi()
body =  # BaseRequestGrammar | grammar
multicolumnMode = multicolumnMode_example # String | multicolumnMode (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get filters
    api_response = api_instance.get_filter_by_columns(body, multicolumnMode=multicolumnMode, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ValueSearchControllerApi->getFilterByColumns: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
multicolumnMode
String
multicolumnMode
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getValueSearchResult

Get Value search result


/service/value_search/data

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/value_search/data?ctx=&jobKey=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ValueSearchControllerApi;

import java.io.File;
import java.util.*;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        Integer ctx = 56; // Integer | ctx
        String jobKey = jobKey_example; // String | jobKey
        Long project = 789; // Long | Project id
        try {
            ExecDataResult result = apiInstance.getValueSearchResult(ctx, jobKey, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#getValueSearchResult");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ValueSearchControllerApi;

public class ValueSearchControllerApiExample {

    public static void main(String[] args) {
        ValueSearchControllerApi apiInstance = new ValueSearchControllerApi();
        Integer ctx = 56; // Integer | ctx
        String jobKey = jobKey_example; // String | jobKey
        Long project = 789; // Long | Project id
        try {
            ExecDataResult result = apiInstance.getValueSearchResult(ctx, jobKey, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ValueSearchControllerApi#getValueSearchResult");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *jobKey = jobKey_example; // jobKey (optional)
Long *project = 789; // Project id (optional)

ValueSearchControllerApi *apiInstance = [[ValueSearchControllerApi alloc] init];

// Get Value search result
[apiInstance getValueSearchResultWith:ctx
    jobKey:jobKey
    project:project
              completionHandler: ^(ExecDataResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.ValueSearchControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'jobKey': jobKey_example, // {{String}} jobKey
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getValueSearchResult(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getValueSearchResultExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ValueSearchControllerApi();
            var ctx = 56;  // Integer | ctx
            var jobKey = jobKey_example;  // String | jobKey (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get Value search result
                ExecDataResult result = apiInstance.getValueSearchResult(ctx, jobKey, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ValueSearchControllerApi.getValueSearchResult: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiValueSearchControllerApi();
$ctx = 56; // Integer | ctx
$jobKey = jobKey_example; // String | jobKey
$project = 789; // Long | Project id

try {
    $result = $api_instance->getValueSearchResult($ctx, $jobKey, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValueSearchControllerApi->getValueSearchResult: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ValueSearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ValueSearchControllerApi->new();
my $ctx = 56; # Integer | ctx
my $jobKey = jobKey_example; # String | jobKey
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getValueSearchResult(ctx => $ctx, jobKey => $jobKey, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ValueSearchControllerApi->getValueSearchResult: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ValueSearchControllerApi()
ctx = 56 # Integer | ctx
jobKey = jobKey_example # String | jobKey (optional)
project = 789 # Long | Project id (optional)

try: 
    # Get Value search result
    api_response = api_instance.get_value_search_result(ctx, jobKey=jobKey, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ValueSearchControllerApi->getValueSearchResult: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
jobKey
String
jobKey
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


WebUiParametersController

getWebUiUrlUsingGET

getWebUiUrl


/service/webUiUrl

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/webUiUrl"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebUiParametersControllerApi;

import java.io.File;
import java.util.*;

public class WebUiParametersControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WebUiParametersControllerApi apiInstance = new WebUiParametersControllerApi();
        try {
            'String' result = apiInstance.getWebUiUrlUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUiParametersControllerApi#getWebUiUrlUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebUiParametersControllerApi;

public class WebUiParametersControllerApiExample {

    public static void main(String[] args) {
        WebUiParametersControllerApi apiInstance = new WebUiParametersControllerApi();
        try {
            'String' result = apiInstance.getWebUiUrlUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUiParametersControllerApi#getWebUiUrlUsingGET");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

WebUiParametersControllerApi *apiInstance = [[WebUiParametersControllerApi alloc] init];

// getWebUiUrl
[apiInstance getWebUiUrlUsingGETWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.WebUiParametersControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebUiUrlUsingGET(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWebUiUrlUsingGETExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WebUiParametersControllerApi();

            try
            {
                // getWebUiUrl
                'String' result = apiInstance.getWebUiUrlUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebUiParametersControllerApi.getWebUiUrlUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiWebUiParametersControllerApi();

try {
    $result = $api_instance->getWebUiUrlUsingGET();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebUiParametersControllerApi->getWebUiUrlUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebUiParametersControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WebUiParametersControllerApi->new();

eval { 
    my $result = $api_instance->getWebUiUrlUsingGET();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebUiParametersControllerApi->getWebUiUrlUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebUiParametersControllerApi()

try: 
    # getWebUiUrl
    api_response = api_instance.get_web_ui_url_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebUiParametersControllerApi->getWebUiUrlUsingGET: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


XmlDepotController

createXmlDepot

create Xml Depot


/service/depots/xml

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml?ISO3Country=&ISO3Language=&country=&ctx=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        XmlDepot body = ; // XmlDepot | xmlDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            XmlDepot result = apiInstance.createXmlDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        XmlDepot body = ; // XmlDepot | xmlDepot
        Integer ctx = 56; // Integer | ctx
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            XmlDepot result = apiInstance.createXmlDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
XmlDepot *body = ; // xmlDepot
Integer *ctx = 56; // ctx
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// create Xml Depot
[apiInstance createXmlDepotWith:body
    ctx:ctx
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(XmlDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{XmlDepot}} xmlDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createXmlDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createXmlDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new XmlDepot(); // XmlDepot | xmlDepot
            var ctx = 56;  // Integer | ctx
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Xml Depot
                XmlDepot result = apiInstance.createXmlDepot(body, ctx, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.createXmlDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // XmlDepot | xmlDepot
$ctx = 56; // Integer | ctx
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createXmlDepot($body, $ctx, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->createXmlDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::XmlDepot->new(); # XmlDepot | xmlDepot
my $ctx = 56; # Integer | ctx
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createXmlDepot(body => $body, ctx => $ctx, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->createXmlDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # XmlDepot | xmlDepot
ctx = 56 # Integer | ctx
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Xml Depot
    api_response = api_instance.create_xml_depot(body, ctx, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->createXmlDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
ctx*
Integer (int32)
ctx
Required
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createXmlDepotHeader

create Depot Header


/service/depots/xml/{depotId}/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createXmlDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            array[DepotHeader] result = apiInstance.createXmlDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// create Depot Header
[apiInstance createXmlDepotHeaderWith:body
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createXmlDepotHeader(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createXmlDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // create Depot Header
                array[DepotHeader] result = apiInstance.createXmlDepotHeader(body, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.createXmlDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $result = $api_instance->createXmlDepotHeader($body, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->createXmlDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    my $result = $api_instance->createXmlDepotHeader(body => $body, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->createXmlDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # DepotHeader | depotHeader
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # create Depot Header
    api_response = api_instance.create_xml_depot_header(body, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->createXmlDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createXmlExtraction

create Extraction


/service/depots/xml/{depotId}/extractions

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createXmlExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            apiInstance.createXmlExtraction(depotId, ctx, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Integer *ctx = 56; // ctx (optional)
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// create Extraction
[apiInstance createXmlExtractionWith:depotId
    ctx:ctx
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'ctx': 56, // {{Integer}} ctx
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createXmlExtraction(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createXmlExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var ctx = 56;  // Integer | ctx (optional) 
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction
                apiInstance.createXmlExtraction(depotId, ctx, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.createXmlExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$depotId = 789; // Long | depotId
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $api_instance->createXmlExtraction($depotId, $ctx, $project);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->createXmlExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    $api_instance->createXmlExtraction(depotId => $depotId, ctx => $ctx, project => $project);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->createXmlExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
depotId = 789 # Long | depotId
ctx = 56 # Integer | ctx (optional)
project = 789 # Long | Project id (optional)

try: 
    # create Extraction
    api_instance.create_xml_extraction(depotId, ctx=ctx, project=project)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->createXmlExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx
Integer (int32)
ctx
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


createXmlExtractionFilter

create Extraction Filter


/service/depots/xml/filters/{depotId}

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createXmlExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.createXmlExtractionFilter(body, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#createXmlExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// create Extraction Filter
[apiInstance createXmlExtractionFilterWith:body
    depotId:depotId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createXmlExtractionFilter(bodydepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createXmlExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // create Extraction Filter
                ExtractionDateFilter result = apiInstance.createXmlExtractionFilter(body, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.createXmlExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->createXmlExtractionFilter($body, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->createXmlExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->createXmlExtractionFilter(body => $body, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->createXmlExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # create Extraction Filter
    api_response = api_instance.create_xml_extraction_filter(body, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->createXmlExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


deleteAllXmlDepotHeader

delete All Depot Header


/service/depots/xml/{depotId}/headers

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/xml/{depotId}/headers?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllXmlDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteAllXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.deleteAllXmlDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteAllXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// delete All Depot Header
[apiInstance deleteAllXmlDepotHeaderWith:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example, // {{String}} 
  'iSO3Language': iSO3Language_example, // {{String}} 
  'country': country_example, // {{String}} 
  'displayCountry': displayCountry_example, // {{String}} 
  'displayLanguage': displayLanguage_example, // {{String}} 
  'displayName': displayName_example, // {{String}} 
  'displayScript': displayScript_example, // {{String}} 
  'displayVariant': displayVariant_example, // {{String}} 
  'language': language_example, // {{String}} 
  'project': 789, // {{Long}} Project id
  'script': script_example, // {{String}} 
  'unicodeLocaleAttributes': , // {{array[String]}} 
  'unicodeLocaleKeys': , // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllXmlDepotHeader(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAllXmlDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // delete All Depot Header
                apiInstance.deleteAllXmlDepotHeader(depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.deleteAllXmlDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->deleteAllXmlDepotHeader($depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->deleteAllXmlDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->deleteAllXmlDepotHeader(depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->deleteAllXmlDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # delete All Depot Header
    api_instance.delete_all_xml_depot_header(depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->deleteAllXmlDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK


deleteXmlDepot

delete Xml Depot


/service/depots/xml/{depotId}

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/xml/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteXmlDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteXmlDepot(ctx, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// delete Xml Depot
[apiInstance deleteXmlDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteXmlDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteXmlDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Xml Depot
                apiInstance.deleteXmlDepot(ctx, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.deleteXmlDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->deleteXmlDepot($ctx, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->deleteXmlDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteXmlDepot(ctx => $ctx, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->deleteXmlDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # delete Xml Depot
    api_instance.delete_xml_depot(ctx, depotId, project=project)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->deleteXmlDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteXmlDepotFileByName

delete xml file by name


/service/depots/xml/{depotId}/remote_files

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/xml/{depotId}/remote_files?ctx=&fileName=&isTemp=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteXmlDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlDepotFileByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Boolean isTemp = true; // Boolean | isTemp
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteXmlDepotFileByName(ctx, depotId, fileName, isTemp, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlDepotFileByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Boolean *isTemp = true; // isTemp
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// delete xml file by name
[apiInstance deleteXmlDepotFileByNameWith:ctx
    depotId:depotId
    fileName:fileName
    isTemp:isTemp
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var isTemp = true; // {{Boolean}} isTemp
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteXmlDepotFileByName(ctx, depotId, fileName, isTemp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteXmlDepotFileByNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var isTemp = true;  // Boolean | isTemp
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete xml file by name
                apiInstance.deleteXmlDepotFileByName(ctx, depotId, fileName, isTemp, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.deleteXmlDepotFileByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$isTemp = true; // Boolean | isTemp
$project = 789; // Long | Project id

try {
    $api_instance->deleteXmlDepotFileByName($ctx, $depotId, $fileName, $isTemp, $project);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->deleteXmlDepotFileByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $isTemp = true; # Boolean | isTemp
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteXmlDepotFileByName(ctx => $ctx, depotId => $depotId, fileName => $fileName, isTemp => $isTemp, project => $project);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->deleteXmlDepotFileByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
isTemp = true # Boolean | isTemp
project = 789 # Long | Project id (optional)

try: 
    # delete xml file by name
    api_instance.delete_xml_depot_file_by_name(ctx, depotId, fileName, isTemp, project=project)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->deleteXmlDepotFileByName: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
isTemp*
Boolean
isTemp
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteXmlDepotHeader

delete Depot Header


/service/depots/xml/headers/{headerId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteXmlDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteXmlDepotHeader(headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// delete Depot Header
[apiInstance deleteXmlDepotHeaderWith:headerId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteXmlDepotHeader(headerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteXmlDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Depot Header
                Long result = apiInstance.deleteXmlDepotHeader(headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.deleteXmlDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteXmlDepotHeader($headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->deleteXmlDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteXmlDepotHeader(headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->deleteXmlDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # delete Depot Header
    api_response = api_instance.delete_xml_depot_header(headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->deleteXmlDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteXmlExtraction

delete Extraction


/service/depots/xml/{depotId}/extractions

Usage and SDK Samples

curl -X DELETE\
\
"//localhost:80//service/depots/xml/{depotId}/extractions?ctx=&extractionName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteXmlExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlExtraction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        try {
            apiInstance.deleteXmlExtraction(ctx, depotId, extractionName, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlExtraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// delete Extraction
[apiInstance deleteXmlExtractionWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteXmlExtraction(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteXmlExtractionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction
                apiInstance.deleteXmlExtraction(ctx, depotId, extractionName, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.deleteXmlExtraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id

try {
    $api_instance->deleteXmlExtraction($ctx, $depotId, $extractionName, $project);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->deleteXmlExtraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id

eval { 
    $api_instance->deleteXmlExtraction(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->deleteXmlExtraction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction
    api_instance.delete_xml_extraction(ctx, depotId, extractionName, project=project)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->deleteXmlExtraction: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


deleteXmlExtractionFilter

delete Extraction Filter


/service/depots/xml/filters/{filterId}

Usage and SDK Samples

curl -X DELETE\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteXmlExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.deleteXmlExtractionFilter(filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#deleteXmlExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// delete Extraction Filter
[apiInstance deleteXmlExtractionFilterWith:filterId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteXmlExtractionFilter(filterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteXmlExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // delete Extraction Filter
                Long result = apiInstance.deleteXmlExtractionFilter(filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.deleteXmlExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->deleteXmlExtractionFilter($filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->deleteXmlExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->deleteXmlExtractionFilter(filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->deleteXmlExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # delete Extraction Filter
    api_response = api_instance.delete_xml_extraction_filter(filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->deleteXmlExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


detectXmlCharset

Detect xml depot charset

This operation is applied on a random file from the depots files


/service/depots/xml/{depotId}/charset

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/text"\
"//localhost:80//service/depots/xml/{depotId}/charset?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.detectXmlCharset(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#detectXmlCharset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.detectXmlCharset(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#detectXmlCharset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Detect xml depot charset
[apiInstance detectXmlCharsetWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.detectXmlCharset(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class detectXmlCharsetExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Detect xml depot charset
                'String' result = apiInstance.detectXmlCharset(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.detectXmlCharset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->detectXmlCharset($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->detectXmlCharset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->detectXmlCharset(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->detectXmlCharset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Detect xml depot charset
    api_response = api_instance.detect_xml_charset(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->detectXmlCharset: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


downloadLocalXmlFile

Download local xml file


/service/depot/xml/file/download

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depot/xml/file/download?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalXmlFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#downloadLocalXmlFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        String token = token_example; // String | File token
        try {
            apiInstance.downloadLocalXmlFile(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#downloadLocalXmlFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *token = token_example; // File token (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Download local xml file
[apiInstance downloadLocalXmlFileWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var opts = { 
  'token': token_example // {{String}} File token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadLocalXmlFile(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadLocalXmlFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var token = token_example;  // String | File token (optional) 

            try
            {
                // Download local xml file
                apiInstance.downloadLocalXmlFile(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.downloadLocalXmlFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$token = token_example; // String | File token

try {
    $api_instance->downloadLocalXmlFile($token);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->downloadLocalXmlFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $token = token_example; # String | File token

eval { 
    $api_instance->downloadLocalXmlFile(token => $token);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->downloadLocalXmlFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
token = token_example # String | File token (optional)

try: 
    # Download local xml file
    api_instance.download_local_xml_file(token=token)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->downloadLocalXmlFile: %s\n" % e)

Parameters

Query parameters
Name Description
token
String
File token

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


editXmlDepot

edit Xml Depot


/service/depots/xml/{depotId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/{depotId}?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        XmlDepot body = ; // XmlDepot | xmlDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            XmlDepot result = apiInstance.editXmlDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#editXmlDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        XmlDepot body = ; // XmlDepot | xmlDepot
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            XmlDepot result = apiInstance.editXmlDepot(body, ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#editXmlDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
XmlDepot *body = ; // xmlDepot
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// edit Xml Depot
[apiInstance editXmlDepotWith:body
    ctx:ctx
    depotId:depotId
    project:project
              completionHandler: ^(XmlDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{XmlDepot}} xmlDepot
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editXmlDepot(bodyctxdepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editXmlDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new XmlDepot(); // XmlDepot | xmlDepot
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Xml Depot
                XmlDepot result = apiInstance.editXmlDepot(body, ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.editXmlDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // XmlDepot | xmlDepot
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editXmlDepot($body, $ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->editXmlDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::XmlDepot->new(); # XmlDepot | xmlDepot
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editXmlDepot(body => $body, ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->editXmlDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # XmlDepot | xmlDepot
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # edit Xml Depot
    api_response = api_instance.edit_xml_depot(body, ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->editXmlDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


editXmlDepotHeader

edit Depot Header


/service/depots/xml/headers/{headerId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/headers/{headerId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editXmlDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#editXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        DepotHeader body = ; // DepotHeader | depotHeader
        Long headerId = 789; // Long | headerId
        Long project = 789; // Long | Project id
        try {
            DepotHeader result = apiInstance.editXmlDepotHeader(body, headerId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#editXmlDepotHeader");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
DepotHeader *body = ; // depotHeader
Long *headerId = 789; // headerId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// edit Depot Header
[apiInstance editXmlDepotHeaderWith:body
    headerId:headerId
    project:project
              completionHandler: ^(DepotHeader output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{DepotHeader}} depotHeader
var headerId = 789; // {{Long}} headerId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editXmlDepotHeader(bodyheaderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editXmlDepotHeaderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new DepotHeader(); // DepotHeader | depotHeader
            var headerId = 789;  // Long | headerId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Depot Header
                DepotHeader result = apiInstance.editXmlDepotHeader(body, headerId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.editXmlDepotHeader: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // DepotHeader | depotHeader
$headerId = 789; // Long | headerId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editXmlDepotHeader($body, $headerId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->editXmlDepotHeader: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::DepotHeader->new(); # DepotHeader | depotHeader
my $headerId = 789; # Long | headerId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editXmlDepotHeader(body => $body, headerId => $headerId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->editXmlDepotHeader: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # DepotHeader | depotHeader
headerId = 789 # Long | headerId
project = 789 # Long | Project id (optional)

try: 
    # edit Depot Header
    api_response = api_instance.edit_xml_depot_header(body, headerId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->editXmlDepotHeader: %s\n" % e)

Parameters

Path parameters
Name Description
headerId*
Long (int64)
headerId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


editXmlExtractionFilter

edit Extraction Filter


/service/depots/xml/filters/{filterId}

Usage and SDK Samples

curl -X PUT\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/filters/{filterId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editXmlExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#editXmlExtractionFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        ExtractionDateFilter body = ; // ExtractionDateFilter | extractionDateFilter
        Long filterId = 789; // Long | filterId
        Long project = 789; // Long | Project id
        try {
            ExtractionDateFilter result = apiInstance.editXmlExtractionFilter(body, filterId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#editXmlExtractionFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ExtractionDateFilter *body = ; // extractionDateFilter
Long *filterId = 789; // filterId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// edit Extraction Filter
[apiInstance editXmlExtractionFilterWith:body
    filterId:filterId
    project:project
              completionHandler: ^(ExtractionDateFilter output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{ExtractionDateFilter}} extractionDateFilter
var filterId = 789; // {{Long}} filterId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editXmlExtractionFilter(bodyfilterId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editXmlExtractionFilterExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new ExtractionDateFilter(); // ExtractionDateFilter | extractionDateFilter
            var filterId = 789;  // Long | filterId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // edit Extraction Filter
                ExtractionDateFilter result = apiInstance.editXmlExtractionFilter(body, filterId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.editXmlExtractionFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // ExtractionDateFilter | extractionDateFilter
$filterId = 789; // Long | filterId
$project = 789; // Long | Project id

try {
    $result = $api_instance->editXmlExtractionFilter($body, $filterId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->editXmlExtractionFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::ExtractionDateFilter->new(); # ExtractionDateFilter | extractionDateFilter
my $filterId = 789; # Long | filterId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->editXmlExtractionFilter(body => $body, filterId => $filterId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->editXmlExtractionFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # ExtractionDateFilter | extractionDateFilter
filterId = 789 # Long | filterId
project = 789 # Long | Project id (optional)

try: 
    # edit Extraction Filter
    api_response = api_instance.edit_xml_extraction_filter(body, filterId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->editXmlExtractionFilter: %s\n" % e)

Parameters

Path parameters
Name Description
filterId*
Long (int64)
filterId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK


findAllXmlDepots

find All Xml Depots


/service/depots/xml

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[XmlDepot] result = apiInstance.findAllXmlDepots(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#findAllXmlDepots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long project = 789; // Long | Project id
        try {
            array[XmlDepot] result = apiInstance.findAllXmlDepots(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#findAllXmlDepots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// find All Xml Depots
[apiInstance findAllXmlDepotsWith:project
              completionHandler: ^(array[XmlDepot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllXmlDepots(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllXmlDepotsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Xml Depots
                array[XmlDepot] result = apiInstance.findAllXmlDepots(project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.findAllXmlDepots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllXmlDepots($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->findAllXmlDepots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllXmlDepots(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->findAllXmlDepots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
project = 789 # Long | Project id (optional)

try: 
    # find All Xml Depots
    api_response = api_instance.find_all_xml_depots(project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->findAllXmlDepots: %s\n" % e)

Parameters

Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findAllXmlExtractionFilters

find All Extraction Filters


/service/depots/xml/filters/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/filters/{depotId}?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllXmlExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#findAllXmlExtractionFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[ExtractionDateFilter] result = apiInstance.findAllXmlExtractionFilters(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#findAllXmlExtractionFilters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// find All Extraction Filters
[apiInstance findAllXmlExtractionFiltersWith:depotId
    project:project
              completionHandler: ^(array[ExtractionDateFilter] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllXmlExtractionFilters(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllXmlExtractionFiltersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // find All Extraction Filters
                array[ExtractionDateFilter] result = apiInstance.findAllXmlExtractionFilters(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.findAllXmlExtractionFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->findAllXmlExtractionFilters($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->findAllXmlExtractionFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->findAllXmlExtractionFilters(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->findAllXmlExtractionFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # find All Extraction Filters
    api_response = api_instance.find_all_xml_extraction_filters(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->findAllXmlExtractionFilters: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


findOneXmlDepotById

find One Xml Depot By Id


/service/depots/xml/{depotId}

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}?project=&withHeaders="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            XmlDepot result = apiInstance.findOneXmlDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#findOneXmlDepotById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        Boolean withHeaders = true; // Boolean | withHeaders
        try {
            XmlDepot result = apiInstance.findOneXmlDepotById(depotId, project, withHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#findOneXmlDepotById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)
Boolean *withHeaders = true; // withHeaders (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// find One Xml Depot By Id
[apiInstance findOneXmlDepotByIdWith:depotId
    project:project
    withHeaders:withHeaders
              completionHandler: ^(XmlDepot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789, // {{Long}} Project id
  'withHeaders': true // {{Boolean}} withHeaders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findOneXmlDepotById(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findOneXmlDepotByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 
            var withHeaders = true;  // Boolean | withHeaders (optional) 

            try
            {
                // find One Xml Depot By Id
                XmlDepot result = apiInstance.findOneXmlDepotById(depotId, project, withHeaders);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.findOneXmlDepotById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id
$withHeaders = true; // Boolean | withHeaders

try {
    $result = $api_instance->findOneXmlDepotById($depotId, $project, $withHeaders);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->findOneXmlDepotById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id
my $withHeaders = true; # Boolean | withHeaders

eval { 
    my $result = $api_instance->findOneXmlDepotById(depotId => $depotId, project => $project, withHeaders => $withHeaders);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->findOneXmlDepotById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)
withHeaders = true # Boolean | withHeaders (optional)

try: 
    # find One Xml Depot By Id
    api_response = api_instance.find_one_xml_depot_by_id(depotId, project=project, withHeaders=withHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->findOneXmlDepotById: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id
withHeaders
Boolean
withHeaders

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getHeadersFromXmlDepot

Get headers from a XML depot


/service/depots/xml/headers

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/headers?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        XmlDepot body = ; // XmlDepot | xmlDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromXmlDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getHeadersFromXmlDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        XmlDepot body = ; // XmlDepot | xmlDepot
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            array[array[Object]] result = apiInstance.getHeadersFromXmlDepot(body, ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getHeadersFromXmlDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
XmlDepot *body = ; // xmlDepot
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Get headers from a XML depot
[apiInstance getHeadersFromXmlDepotWith:body
    ctx:ctx
    project:project
              completionHandler: ^(array[array[Object]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{XmlDepot}} xmlDepot
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeadersFromXmlDepot(bodyctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHeadersFromXmlDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new XmlDepot(); // XmlDepot | xmlDepot
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get headers from a XML depot
                array[array[Object]] result = apiInstance.getHeadersFromXmlDepot(body, ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getHeadersFromXmlDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // XmlDepot | xmlDepot
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->getHeadersFromXmlDepot($body, $ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getHeadersFromXmlDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = WWW::SwaggerClient::Object::XmlDepot->new(); # XmlDepot | xmlDepot
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getHeadersFromXmlDepot(body => $body, ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getHeadersFromXmlDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # XmlDepot | xmlDepot
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Get headers from a XML depot
    api_response = api_instance.get_headers_from_xml_depot(body, ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getHeadersFromXmlDepot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlDepotExtractions

get Depot Extractions


/service/depots/xml/{depotId}/extractions

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/extractions?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getXmlDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotExtractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array['String'] result = apiInstance.getXmlDepotExtractions(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotExtractions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// get Depot Extractions
[apiInstance getXmlDepotExtractionsWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlDepotExtractions(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlDepotExtractionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Extractions
                array['String'] result = apiInstance.getXmlDepotExtractions(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlDepotExtractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getXmlDepotExtractions($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlDepotExtractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getXmlDepotExtractions(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlDepotExtractions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Extractions
    api_response = api_instance.get_xml_depot_extractions(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlDepotExtractions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlDepotFilesCount

Get xml depot files count


/service/depots/xml/{depotId}/count

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/count?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getXmlDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotFilesCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            Long result = apiInstance.getXmlDepotFilesCount(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotFilesCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Get xml depot files count
[apiInstance getXmlDepotFilesCountWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlDepotFilesCount(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlDepotFilesCountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get xml depot files count
                Long result = apiInstance.getXmlDepotFilesCount(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlDepotFilesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getXmlDepotFilesCount($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlDepotFilesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getXmlDepotFilesCount(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlDepotFilesCount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get xml depot files count
    api_response = api_instance.get_xml_depot_files_count(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlDepotFilesCount: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlDepotHeadersByDepotId

get Depot Headers By Depot Id


/service/depots/xml/{depotId}/headers

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/headers?project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getXmlDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            array[DepotHeader] result = apiInstance.getXmlDepotHeadersByDepotId(depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotHeadersByDepotId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// get Depot Headers By Depot Id
[apiInstance getXmlDepotHeadersByDepotIdWith:depotId
    project:project
              completionHandler: ^(array[DepotHeader] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlDepotHeadersByDepotId(depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlDepotHeadersByDepotIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // get Depot Headers By Depot Id
                array[DepotHeader] result = apiInstance.getXmlDepotHeadersByDepotId(depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlDepotHeadersByDepotId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getXmlDepotHeadersByDepotId($depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlDepotHeadersByDepotId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getXmlDepotHeadersByDepotId(depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlDepotHeadersByDepotId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # get Depot Headers By Depot Id
    api_response = api_instance.get_xml_depot_headers_by_depot_id(depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlDepotHeadersByDepotId: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlDepotRemoteFiles

Get xml depot remoteFiles


/service/depots/xml/{depotId}/remote_files

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/remote_files?ctx=&filenameMask=&includeTemp=&limit=&project=&remotePath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getXmlDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String filenameMask = filenameMask_example; // String | filenameMask
        Boolean includeTemp = true; // Boolean | includeTemp
        Integer limit = 56; // Integer | limit
        Long project = 789; // Long | Project id
        String remotePath = remotePath_example; // String | remotePath
        try {
            array[RemoteFile] result = apiInstance.getXmlDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlDepotRemoteFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *filenameMask = filenameMask_example; // filenameMask
Boolean *includeTemp = true; // includeTemp
Integer *limit = 56; // limit
Long *project = 789; // Project id (optional)
String *remotePath = remotePath_example; // remotePath (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Get xml depot remoteFiles
[apiInstance getXmlDepotRemoteFilesWith:ctx
    depotId:depotId
    filenameMask:filenameMask
    includeTemp:includeTemp
    limit:limit
    project:project
    remotePath:remotePath
              completionHandler: ^(array[RemoteFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var filenameMask = filenameMask_example; // {{String}} filenameMask
var includeTemp = true; // {{Boolean}} includeTemp
var limit = 56; // {{Integer}} limit
var opts = { 
  'project': 789, // {{Long}} Project id
  'remotePath': remotePath_example // {{String}} remotePath
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlDepotRemoteFilesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var filenameMask = filenameMask_example;  // String | filenameMask
            var includeTemp = true;  // Boolean | includeTemp
            var limit = 56;  // Integer | limit
            var project = 789;  // Long | Project id (optional) 
            var remotePath = remotePath_example;  // String | remotePath (optional) 

            try
            {
                // Get xml depot remoteFiles
                array[RemoteFile] result = apiInstance.getXmlDepotRemoteFiles(ctx, depotId, filenameMask, includeTemp, limit, project, remotePath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlDepotRemoteFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$filenameMask = filenameMask_example; // String | filenameMask
$includeTemp = true; // Boolean | includeTemp
$limit = 56; // Integer | limit
$project = 789; // Long | Project id
$remotePath = remotePath_example; // String | remotePath

try {
    $result = $api_instance->getXmlDepotRemoteFiles($ctx, $depotId, $filenameMask, $includeTemp, $limit, $project, $remotePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlDepotRemoteFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $filenameMask = filenameMask_example; # String | filenameMask
my $includeTemp = true; # Boolean | includeTemp
my $limit = 56; # Integer | limit
my $project = 789; # Long | Project id
my $remotePath = remotePath_example; # String | remotePath

eval { 
    my $result = $api_instance->getXmlDepotRemoteFiles(ctx => $ctx, depotId => $depotId, filenameMask => $filenameMask, includeTemp => $includeTemp, limit => $limit, project => $project, remotePath => $remotePath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlDepotRemoteFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
filenameMask = filenameMask_example # String | filenameMask
includeTemp = true # Boolean | includeTemp
limit = 56 # Integer | limit
project = 789 # Long | Project id (optional)
remotePath = remotePath_example # String | remotePath (optional)

try: 
    # Get xml depot remoteFiles
    api_response = api_instance.get_xml_depot_remote_files(ctx, depotId, filenameMask, includeTemp, limit, project=project, remotePath=remotePath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlDepotRemoteFiles: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
filenameMask*
String
filenameMask
Required
includeTemp*
Boolean
includeTemp
Required
limit*
Integer (int32)
limit
Required
project
Long (int64)
Project id
remotePath
String
remotePath

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlExtractionFilePreview

get Extraction File Preview


/service/depots/xml/{depotId}/extractions/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/extractions/preview?ctx=&extractionName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getXmlExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String extractionName = extractionName_example; // String | extractionName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.getXmlExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlExtractionFilePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *extractionName = extractionName_example; // extractionName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// get Extraction File Preview
[apiInstance getXmlExtractionFilePreviewWith:ctx
    depotId:depotId
    extractionName:extractionName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var extractionName = extractionName_example; // {{String}} extractionName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlExtractionFilePreview(ctx, depotId, extractionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlExtractionFilePreviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var extractionName = extractionName_example;  // String | extractionName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // get Extraction File Preview
                DepotData result = apiInstance.getXmlExtractionFilePreview(ctx, depotId, extractionName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlExtractionFilePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$extractionName = extractionName_example; // String | extractionName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->getXmlExtractionFilePreview($ctx, $depotId, $extractionName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlExtractionFilePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $extractionName = extractionName_example; # String | extractionName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->getXmlExtractionFilePreview(ctx => $ctx, depotId => $depotId, extractionName => $extractionName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlExtractionFilePreview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
extractionName = extractionName_example # String | extractionName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # get Extraction File Preview
    api_response = api_instance.get_xml_extraction_file_preview(ctx, depotId, extractionName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlExtractionFilePreview: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
extractionName*
String
extractionName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlFileDownloadToken

Get download token for a local xml file


/service/depot/xml/{depotId}/file/token

Usage and SDK Samples

curl -X GET\
\
-H "Accept: text/plain"\
"//localhost:80//service/depot/xml/{depotId}/file/token?fileName=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getXmlFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlFileDownloadToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        try {
            'String' result = apiInstance.getXmlFileDownloadToken(depotId, fileName, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlFileDownloadToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Get download token for a local xml file
[apiInstance getXmlFileDownloadTokenWith:depotId
    fileName:fileName
    project:project
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlFileDownloadToken(depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlFileDownloadTokenExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get download token for a local xml file
                'String' result = apiInstance.getXmlFileDownloadToken(depotId, fileName, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlFileDownloadToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id

try {
    $result = $api_instance->getXmlFileDownloadToken($depotId, $fileName, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlFileDownloadToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getXmlFileDownloadToken(depotId => $depotId, fileName => $fileName, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlFileDownloadToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)

try: 
    # Get download token for a local xml file
    api_response = api_instance.get_xml_file_download_token(depotId, fileName, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlFileDownloadToken: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
fileName*
String
fileName
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


getXmlPreviewDepot

Get XML depot preview


/service/depots/xml/{depotId}/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/preview?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getXmlPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlPreviewDepot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            DepotData result = apiInstance.getXmlPreviewDepot(ctx, depotId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#getXmlPreviewDepot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Get XML depot preview
[apiInstance getXmlPreviewDepotWith:ctx
    depotId:depotId
    project:project
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getXmlPreviewDepot(ctx, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getXmlPreviewDepotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Get XML depot preview
                DepotData result = apiInstance.getXmlPreviewDepot(ctx, depotId, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.getXmlPreviewDepot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $result = $api_instance->getXmlPreviewDepot($ctx, $depotId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->getXmlPreviewDepot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->getXmlPreviewDepot(ctx => $ctx, depotId => $depotId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->getXmlPreviewDepot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # Get XML depot preview
    api_response = api_instance.get_xml_preview_depot(ctx, depotId, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->getXmlPreviewDepot: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


handleXmlFileUpload

Upload xml file to a depot


/service/depots/xml/upload_file

Usage and SDK Samples

curl -X POST\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/upload_file?ctx=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleXmlFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#handleXmlFileUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long project = 789; // Long | Project id
        try {
            FileUpload result = apiInstance.handleXmlFileUpload(ctx, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#handleXmlFileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Upload xml file to a depot
[apiInstance handleXmlFileUploadWith:ctx
    project:project
              completionHandler: ^(FileUpload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleXmlFileUpload(ctx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleXmlFileUploadExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // Upload xml file to a depot
                FileUpload result = apiInstance.handleXmlFileUpload(ctx, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.handleXmlFileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$project = 789; // Long | Project id

try {
    $result = $api_instance->handleXmlFileUpload($ctx, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->handleXmlFileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $project = 789; # Long | Project id

eval { 
    my $result = $api_instance->handleXmlFileUpload(ctx => $ctx, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->handleXmlFileUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
project = 789 # Long | Project id (optional)

try: 
    # Upload xml file to a depot
    api_response = api_instance.handle_xml_file_upload(ctx, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->handleXmlFileUpload: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


moveXmlDepotTempFolderOnTypeUpdate

move temp folder when type is changed


/service/depots/xml/move_tmp_folder_on_type_update

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/xml/move_tmp_folder_on_type_update?ctx=&depotCode=&newDepotType=&oldDepotType=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveXmlDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#moveXmlDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        String depotCode = depotCode_example; // String | depotCode
        String newDepotType = newDepotType_example; // String | newDepotType
        String oldDepotType = oldDepotType_example; // String | oldDepotType
        Long project = 789; // Long | Project id
        try {
            apiInstance.moveXmlDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#moveXmlDepotTempFolderOnTypeUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
String *depotCode = depotCode_example; // depotCode
String *newDepotType = newDepotType_example; // newDepotType
String *oldDepotType = oldDepotType_example; // oldDepotType
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// move temp folder when type is changed
[apiInstance moveXmlDepotTempFolderOnTypeUpdateWith:ctx
    depotCode:depotCode
    newDepotType:newDepotType
    oldDepotType:oldDepotType
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotCode = depotCode_example; // {{String}} depotCode
var newDepotType = newDepotType_example; // {{String}} newDepotType
var oldDepotType = oldDepotType_example; // {{String}} oldDepotType
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.moveXmlDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class moveXmlDepotTempFolderOnTypeUpdateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotCode = depotCode_example;  // String | depotCode
            var newDepotType = newDepotType_example;  // String | newDepotType
            var oldDepotType = oldDepotType_example;  // String | oldDepotType
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // move temp folder when type is changed
                apiInstance.moveXmlDepotTempFolderOnTypeUpdate(ctx, depotCode, newDepotType, oldDepotType, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.moveXmlDepotTempFolderOnTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotCode = depotCode_example; // String | depotCode
$newDepotType = newDepotType_example; // String | newDepotType
$oldDepotType = oldDepotType_example; // String | oldDepotType
$project = 789; // Long | Project id

try {
    $api_instance->moveXmlDepotTempFolderOnTypeUpdate($ctx, $depotCode, $newDepotType, $oldDepotType, $project);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->moveXmlDepotTempFolderOnTypeUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotCode = depotCode_example; # String | depotCode
my $newDepotType = newDepotType_example; # String | newDepotType
my $oldDepotType = oldDepotType_example; # String | oldDepotType
my $project = 789; # Long | Project id

eval { 
    $api_instance->moveXmlDepotTempFolderOnTypeUpdate(ctx => $ctx, depotCode => $depotCode, newDepotType => $newDepotType, oldDepotType => $oldDepotType, project => $project);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->moveXmlDepotTempFolderOnTypeUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotCode = depotCode_example # String | depotCode
newDepotType = newDepotType_example # String | newDepotType
oldDepotType = oldDepotType_example # String | oldDepotType
project = 789 # Long | Project id (optional)

try: 
    # move temp folder when type is changed
    api_instance.move_xml_depot_temp_folder_on_type_update(ctx, depotCode, newDepotType, oldDepotType, project=project)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->moveXmlDepotTempFolderOnTypeUpdate: %s\n" % e)

Parameters

Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
depotCode*
String
depotCode
Required
newDepotType*
String
newDepotType
Required
oldDepotType*
String
oldDepotType
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


previewRemoteXmlFile

Get xml depot file preview


/service/depots/xml/{depotId}/remote_files/preview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: */*"\
"//localhost:80//service/depots/xml/{depotId}/remote_files/preview?ctx=&fileName=&project=&useCache="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteXmlFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#previewRemoteXmlFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Integer ctx = 56; // Integer | ctx
        Long depotId = 789; // Long | depotId
        String fileName = fileName_example; // String | fileName
        Long project = 789; // Long | Project id
        Boolean useCache = true; // Boolean | useCache
        try {
            DepotData result = apiInstance.previewRemoteXmlFile(ctx, depotId, fileName, project, useCache);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#previewRemoteXmlFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *ctx = 56; // ctx
Long *depotId = 789; // depotId
String *fileName = fileName_example; // fileName
Long *project = 789; // Project id (optional)
Boolean *useCache = true; // useCache (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// Get xml depot file preview
[apiInstance previewRemoteXmlFileWith:ctx
    depotId:depotId
    fileName:fileName
    project:project
    useCache:useCache
              completionHandler: ^(DepotData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var ctx = 56; // {{Integer}} ctx
var depotId = 789; // {{Long}} depotId
var fileName = fileName_example; // {{String}} fileName
var opts = { 
  'project': 789, // {{Long}} Project id
  'useCache': true // {{Boolean}} useCache
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.previewRemoteXmlFile(ctx, depotId, fileName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class previewRemoteXmlFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var ctx = 56;  // Integer | ctx
            var depotId = 789;  // Long | depotId
            var fileName = fileName_example;  // String | fileName
            var project = 789;  // Long | Project id (optional) 
            var useCache = true;  // Boolean | useCache (optional) 

            try
            {
                // Get xml depot file preview
                DepotData result = apiInstance.previewRemoteXmlFile(ctx, depotId, fileName, project, useCache);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.previewRemoteXmlFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$ctx = 56; // Integer | ctx
$depotId = 789; // Long | depotId
$fileName = fileName_example; // String | fileName
$project = 789; // Long | Project id
$useCache = true; // Boolean | useCache

try {
    $result = $api_instance->previewRemoteXmlFile($ctx, $depotId, $fileName, $project, $useCache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->previewRemoteXmlFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $ctx = 56; # Integer | ctx
my $depotId = 789; # Long | depotId
my $fileName = fileName_example; # String | fileName
my $project = 789; # Long | Project id
my $useCache = true; # Boolean | useCache

eval { 
    my $result = $api_instance->previewRemoteXmlFile(ctx => $ctx, depotId => $depotId, fileName => $fileName, project => $project, useCache => $useCache);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->previewRemoteXmlFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
ctx = 56 # Integer | ctx
depotId = 789 # Long | depotId
fileName = fileName_example # String | fileName
project = 789 # Long | Project id (optional)
useCache = true # Boolean | useCache (optional)

try: 
    # Get xml depot file preview
    api_response = api_instance.preview_remote_xml_file(ctx, depotId, fileName, project=project, useCache=useCache)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->previewRemoteXmlFile: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
ctx*
Integer (int32)
ctx
Required
fileName*
String
fileName
Required
project
Long (int64)
Project id
useCache
Boolean
useCache

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Bad Request

Status: 404 - Bad Request

Status: 500 - Server error Try again later


updateXmlDepotActivationStatus

update Depot Activation Status


/service/depots/xml/{depotId}/active

Usage and SDK Samples

curl -X PUT\
\
"//localhost:80//service/depots/xml/{depotId}/active?active=&project="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateXmlDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#updateXmlDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        Boolean active = true; // Boolean | active
        Long depotId = 789; // Long | depotId
        Long project = 789; // Long | Project id
        try {
            apiInstance.updateXmlDepotActivationStatus(active, depotId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#updateXmlDepotActivationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *active = true; // active
Long *depotId = 789; // depotId
Long *project = 789; // Project id (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// update Depot Activation Status
[apiInstance updateXmlDepotActivationStatusWith:active
    depotId:depotId
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var active = true; // {{Boolean}} active
var depotId = 789; // {{Long}} depotId
var opts = { 
  'project': 789 // {{Long}} Project id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateXmlDepotActivationStatus(active, depotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateXmlDepotActivationStatusExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var active = true;  // Boolean | active
            var depotId = 789;  // Long | depotId
            var project = 789;  // Long | Project id (optional) 

            try
            {
                // update Depot Activation Status
                apiInstance.updateXmlDepotActivationStatus(active, depotId, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.updateXmlDepotActivationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$active = true; // Boolean | active
$depotId = 789; // Long | depotId
$project = 789; // Long | Project id

try {
    $api_instance->updateXmlDepotActivationStatus($active, $depotId, $project);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->updateXmlDepotActivationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $active = true; # Boolean | active
my $depotId = 789; # Long | depotId
my $project = 789; # Long | Project id

eval { 
    $api_instance->updateXmlDepotActivationStatus(active => $active, depotId => $depotId, project => $project);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->updateXmlDepotActivationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
active = true # Boolean | active
depotId = 789 # Long | depotId
project = 789 # Long | Project id (optional)

try: 
    # update Depot Activation Status
    api_instance.update_xml_depot_activation_status(active, depotId, project=project)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->updateXmlDepotActivationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Query parameters
Name Description
active*
Boolean
active
Required
project
Long (int64)
Project id

Responses

Status: 200 - OK


updateXmlDepotHeadersPositions

update Depot Headers Positions


/service/depots/xml/{depotId}/headers/update_position

Usage and SDK Samples

curl -X PUT\
\
-H "Content-Type: application/json"\
"//localhost:80//service/depots/xml/{depotId}/headers/update_position?ISO3Country=&ISO3Language=&country=&displayCountry=&displayLanguage=&displayName=&displayScript=&displayVariant=&headresReUploaded=&language=&project=&script=&unicodeLocaleAttributes=&unicodeLocaleKeys=&variant="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XmlDepotControllerApi;

import java.io.File;
import java.util.*;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateXmlDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#updateXmlDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XmlDepotControllerApi;

public class XmlDepotControllerApiExample {

    public static void main(String[] args) {
        XmlDepotControllerApi apiInstance = new XmlDepotControllerApi();
        array[DepotHeader] body = ; // array[DepotHeader] | depotHeaders
        Boolean headresReUploaded = true; // Boolean | headresReUploaded
        Long depotId = 789; // Long | depotId
        String iSO3Country = iSO3Country_example; // String | 
        String iSO3Language = iSO3Language_example; // String | 
        String country = country_example; // String | 
        String displayCountry = displayCountry_example; // String | 
        String displayLanguage = displayLanguage_example; // String | 
        String displayName = displayName_example; // String | 
        String displayScript = displayScript_example; // String | 
        String displayVariant = displayVariant_example; // String | 
        String language = language_example; // String | 
        Long project = 789; // Long | Project id
        String script = script_example; // String | 
        array[String] unicodeLocaleAttributes = ; // array[String] | 
        array[String] unicodeLocaleKeys = ; // array[String] | 
        String variant = variant_example; // String | 
        try {
            apiInstance.updateXmlDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
        } catch (ApiException e) {
            System.err.println("Exception when calling XmlDepotControllerApi#updateXmlDepotHeadersPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[DepotHeader] *body = ; // depotHeaders
Boolean *headresReUploaded = true; // headresReUploaded
Long *depotId = 789; // depotId
String *iSO3Country = iSO3Country_example; //  (optional)
String *iSO3Language = iSO3Language_example; //  (optional)
String *country = country_example; //  (optional)
String *displayCountry = displayCountry_example; //  (optional)
String *displayLanguage = displayLanguage_example; //  (optional)
String *displayName = displayName_example; //  (optional)
String *displayScript = displayScript_example; //  (optional)
String *displayVariant = displayVariant_example; //  (optional)
String *language = language_example; //  (optional)
Long *project = 789; // Project id (optional)
String *script = script_example; //  (optional)
array[String] *unicodeLocaleAttributes = ; //  (optional)
array[String] *unicodeLocaleKeys = ; //  (optional)
String *variant = variant_example; //  (optional)

XmlDepotControllerApi *apiInstance = [[XmlDepotControllerApi alloc] init];

// update Depot Headers Positions
[apiInstance updateXmlDepotHeadersPositionsWith:body
    headresReUploaded:headresReUploaded
    depotId:depotId
    iSO3Country:iSO3Country
    iSO3Language:iSO3Language
    country:country
    displayCountry:displayCountry
    displayLanguage:displayLanguage
    displayName:displayName
    displayScript:displayScript
    displayVariant:displayVariant
    language:language
    project:project
    script:script
    unicodeLocaleAttributes:unicodeLocaleAttributes
    unicodeLocaleKeys:unicodeLocaleKeys
    variant:variant
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DatachainCoreApi = require('datachain_core_api');
var defaultClient = DatachainCoreApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new DatachainCoreApi.XmlDepotControllerApi()
var body = ; // {{array[DepotHeader]}} depotHeaders
var headresReUploaded = true; // {{Boolean}} headresReUploaded
var depotId = 789; // {{Long}} depotId
var opts = { 
  'iSO3Country': iSO3Country_example // {{String}} 
  'iSO3Language': iSO3Language_example // {{String}} 
  'country': country_example // {{String}} 
  'displayCountry': displayCountry_example // {{String}} 
  'displayLanguage': displayLanguage_example // {{String}} 
  'displayName': displayName_example // {{String}} 
  'displayScript': displayScript_example // {{String}} 
  'displayVariant': displayVariant_example // {{String}} 
  'language': language_example // {{String}} 
  'project': 789 // {{Long}} Project id
  'script': script_example // {{String}} 
  'unicodeLocaleAttributes':  // {{array[String]}} 
  'unicodeLocaleKeys':  // {{array[String]}} 
  'variant': variant_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateXmlDepotHeadersPositions(bodyheadresReUploadeddepotId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateXmlDepotHeadersPositionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new XmlDepotControllerApi();
            var body = new array[DepotHeader](); // array[DepotHeader] | depotHeaders
            var headresReUploaded = true;  // Boolean | headresReUploaded
            var depotId = 789;  // Long | depotId
            var iSO3Country = iSO3Country_example;  // String |  (optional) 
            var iSO3Language = iSO3Language_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 
            var displayCountry = displayCountry_example;  // String |  (optional) 
            var displayLanguage = displayLanguage_example;  // String |  (optional) 
            var displayName = displayName_example;  // String |  (optional) 
            var displayScript = displayScript_example;  // String |  (optional) 
            var displayVariant = displayVariant_example;  // String |  (optional) 
            var language = language_example;  // String |  (optional) 
            var project = 789;  // Long | Project id (optional) 
            var script = script_example;  // String |  (optional) 
            var unicodeLocaleAttributes = new array[String](); // array[String] |  (optional) 
            var unicodeLocaleKeys = new array[String](); // array[String] |  (optional) 
            var variant = variant_example;  // String |  (optional) 

            try
            {
                // update Depot Headers Positions
                apiInstance.updateXmlDepotHeadersPositions(body, headresReUploaded, depotId, iSO3Country, iSO3Language, country, displayCountry, displayLanguage, displayName, displayScript, displayVariant, language, project, script, unicodeLocaleAttributes, unicodeLocaleKeys, variant);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XmlDepotControllerApi.updateXmlDepotHeadersPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiXmlDepotControllerApi();
$body = ; // array[DepotHeader] | depotHeaders
$headresReUploaded = true; // Boolean | headresReUploaded
$depotId = 789; // Long | depotId
$iSO3Country = iSO3Country_example; // String | 
$iSO3Language = iSO3Language_example; // String | 
$country = country_example; // String | 
$displayCountry = displayCountry_example; // String | 
$displayLanguage = displayLanguage_example; // String | 
$displayName = displayName_example; // String | 
$displayScript = displayScript_example; // String | 
$displayVariant = displayVariant_example; // String | 
$language = language_example; // String | 
$project = 789; // Long | Project id
$script = script_example; // String | 
$unicodeLocaleAttributes = ; // array[String] | 
$unicodeLocaleKeys = ; // array[String] | 
$variant = variant_example; // String | 

try {
    $api_instance->updateXmlDepotHeadersPositions($body, $headresReUploaded, $depotId, $iSO3Country, $iSO3Language, $country, $displayCountry, $displayLanguage, $displayName, $displayScript, $displayVariant, $language, $project, $script, $unicodeLocaleAttributes, $unicodeLocaleKeys, $variant);
} catch (Exception $e) {
    echo 'Exception when calling XmlDepotControllerApi->updateXmlDepotHeadersPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XmlDepotControllerApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::XmlDepotControllerApi->new();
my $body = [WWW::SwaggerClient::Object::array[DepotHeader]->new()]; # array[DepotHeader] | depotHeaders
my $headresReUploaded = true; # Boolean | headresReUploaded
my $depotId = 789; # Long | depotId
my $iSO3Country = iSO3Country_example; # String | 
my $iSO3Language = iSO3Language_example; # String | 
my $country = country_example; # String | 
my $displayCountry = displayCountry_example; # String | 
my $displayLanguage = displayLanguage_example; # String | 
my $displayName = displayName_example; # String | 
my $displayScript = displayScript_example; # String | 
my $displayVariant = displayVariant_example; # String | 
my $language = language_example; # String | 
my $project = 789; # Long | Project id
my $script = script_example; # String | 
my $unicodeLocaleAttributes = []; # array[String] | 
my $unicodeLocaleKeys = []; # array[String] | 
my $variant = variant_example; # String | 

eval { 
    $api_instance->updateXmlDepotHeadersPositions(body => $body, headresReUploaded => $headresReUploaded, depotId => $depotId, iSO3Country => $iSO3Country, iSO3Language => $iSO3Language, country => $country, displayCountry => $displayCountry, displayLanguage => $displayLanguage, displayName => $displayName, displayScript => $displayScript, displayVariant => $displayVariant, language => $language, project => $project, script => $script, unicodeLocaleAttributes => $unicodeLocaleAttributes, unicodeLocaleKeys => $unicodeLocaleKeys, variant => $variant);
};
if ($@) {
    warn "Exception when calling XmlDepotControllerApi->updateXmlDepotHeadersPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.XmlDepotControllerApi()
body =  # array[DepotHeader] | depotHeaders
headresReUploaded = true # Boolean | headresReUploaded
depotId = 789 # Long | depotId
iSO3Country = iSO3Country_example # String |  (optional)
iSO3Language = iSO3Language_example # String |  (optional)
country = country_example # String |  (optional)
displayCountry = displayCountry_example # String |  (optional)
displayLanguage = displayLanguage_example # String |  (optional)
displayName = displayName_example # String |  (optional)
displayScript = displayScript_example # String |  (optional)
displayVariant = displayVariant_example # String |  (optional)
language = language_example # String |  (optional)
project = 789 # Long | Project id (optional)
script = script_example # String |  (optional)
unicodeLocaleAttributes =  # array[String] |  (optional)
unicodeLocaleKeys =  # array[String] |  (optional)
variant = variant_example # String |  (optional)

try: 
    # update Depot Headers Positions
    api_instance.update_xml_depot_headers_positions(body, headresReUploaded, depotId, iSO3Country=iSO3Country, iSO3Language=iSO3Language, country=country, displayCountry=displayCountry, displayLanguage=displayLanguage, displayName=displayName, displayScript=displayScript, displayVariant=displayVariant, language=language, project=project, script=script, unicodeLocaleAttributes=unicodeLocaleAttributes, unicodeLocaleKeys=unicodeLocaleKeys, variant=variant)
except ApiException as e:
    print("Exception when calling XmlDepotControllerApi->updateXmlDepotHeadersPositions: %s\n" % e)

Parameters

Path parameters
Name Description
depotId*
Long (int64)
depotId
Required
Body parameters
Name Description
body *
Query parameters
Name Description
ISO3Country
String
ISO3Language
String
country
String
displayCountry
String
displayLanguage
String
displayName
String
displayScript
String
displayVariant
String
headresReUploaded*
Boolean
headresReUploaded
Required
language
String
project
Long (int64)
Project id
script
String
unicodeLocaleAttributes
array[String]
unicodeLocaleKeys
array[String]
variant
String

Responses

Status: 200 - OK