Starburst Enterprise API documentation

DataProducts

cloneDataProduct

Clone a data product

Clone an existing data product within the same domain. All datasets are cloned as well as tags and sample queries.


/api/v1/dataProduct/products/{dataProductId}/clone

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/clone"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        CloneDataProductPayload body = ; // CloneDataProductPayload | 
        try {
            Data product result = apiInstance.cloneDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#cloneDataProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        CloneDataProductPayload body = ; // CloneDataProductPayload | 
        try {
            Data product result = apiInstance.cloneDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#cloneDataProduct");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
CloneDataProductPayload *body = ; //  (optional)

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

// Clone a data product
[apiInstance cloneDataProductWith:dataProductId
    body:body
              completionHandler: ^(Data product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'body':  // {{CloneDataProductPayload}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cloneDataProduct(dataProductId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var dataProductId = new UUID(); // UUID | 
            var body = new CloneDataProductPayload(); // CloneDataProductPayload |  (optional) 

            try
            {
                // Clone a data product
                Data product result = apiInstance.cloneDataProduct(dataProductId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.cloneDataProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = ; // CloneDataProductPayload | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = WWW::SwaggerClient::Object::CloneDataProductPayload->new(); # CloneDataProductPayload | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
body =  # CloneDataProductPayload |  (optional)

try: 
    # Clone a data product
    api_response = api_instance.clone_data_product(dataProductId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->cloneDataProduct: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found

Status: 409 - Conflict


createDataProduct

Create a data product

This request creates a data product in a DRAFT status. At this stage the data product's schema and datasets are not yet available to be queried in SEP. It is only available for querying after it gets published, as part of the publishing workflow.


/api/v1/dataProduct/products

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        DataProductPayload body = ; // DataProductPayload | 
        try {
            Data product result = apiInstance.createDataProduct(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#createDataProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        DataProductPayload body = ; // DataProductPayload | 
        try {
            Data product result = apiInstance.createDataProduct(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#createDataProduct");
            e.printStackTrace();
        }
    }
}
DataProductPayload *body = ; //  (optional)

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

// Create a data product
[apiInstance createDataProductWith:body
              completionHandler: ^(Data product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var opts = { 
  'body':  // {{DataProductPayload}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDataProduct(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var body = new DataProductPayload(); // DataProductPayload |  (optional) 

            try
            {
                // Create a data product
                Data product result = apiInstance.createDataProduct(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.createDataProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$body = ; // DataProductPayload | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $body = WWW::SwaggerClient::Object::DataProductPayload->new(); # DataProductPayload | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
body =  # DataProductPayload |  (optional)

try: 
    # Create a data product
    api_response = api_instance.create_data_product(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->createDataProduct: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 409 - Conflict


getDataProduct

Get a data product by identifier


/api/v1/dataProduct/products/{dataProductId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/products/{dataProductId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            Data product result = apiInstance.getDataProduct(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getDataProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            Data product result = apiInstance.getDataProduct(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getDataProduct");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Get a data product by identifier
[apiInstance getDataProductWith:dataProductId
              completionHandler: ^(Data product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataProduct(dataProductId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var dataProductId = new UUID(); // UUID | 

            try
            {
                // Get a data product by identifier
                Data product result = apiInstance.getDataProduct(dataProductId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.getDataProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Get a data product by identifier
    api_response = api_instance.get_data_product(dataProductId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->getDataProduct: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Status: 403 - Forbidden

Status: 404 - Not found


getMaterializedViewRefreshMetadata

Get refresh meta data about a materialized view that belongs to a data product


/api/v1/dataProduct/products/{dataProductId}/materializedViews/{viewName}/refreshMetadata

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/materializedViews/{viewName}/refreshMetadata"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String viewName = viewName_example; // String | 
        try {
            Materialized view refresh metadata result = apiInstance.getMaterializedViewRefreshMetadata(dataProductId, viewName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getMaterializedViewRefreshMetadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String viewName = viewName_example; // String | 
        try {
            Materialized view refresh metadata result = apiInstance.getMaterializedViewRefreshMetadata(dataProductId, viewName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getMaterializedViewRefreshMetadata");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *viewName = viewName_example; // 

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

// Get refresh meta data about a materialized view that belongs to a data product
[apiInstance getMaterializedViewRefreshMetadataWith:dataProductId
    viewName:viewName
              completionHandler: ^(Materialized view refresh metadata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var viewName = viewName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMaterializedViewRefreshMetadata(dataProductId, viewName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var dataProductId = new UUID(); // UUID | 
            var viewName = viewName_example;  // String | 

            try
            {
                // Get refresh meta data about a materialized view that belongs to a data product
                Materialized view refresh metadata result = apiInstance.getMaterializedViewRefreshMetadata(dataProductId, viewName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.getMaterializedViewRefreshMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$viewName = viewName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $viewName = viewName_example; # String | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
viewName = viewName_example # String | 

try: 
    # Get refresh meta data about a materialized view that belongs to a data product
    api_response = api_instance.get_materialized_view_refresh_metadata(dataProductId, viewName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->getMaterializedViewRefreshMetadata: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
viewName*
String
Required

Responses

Status: 200 - Success

Status: 403 - Forbidden

Status: 404 - Not found


getOpenApi

Return the OpenAPI specification for the Data Product API. Use a Content-Type of 'application/yaml' to request a YAML response instead of JSON.


/api/v1/dataProduct/openApi

Usage and SDK Samples

curl -X GET\
-H "Accept: application/yaml"\
"//api/v1/dataProduct/openApi"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        try {
            apiInstance.getOpenApi();
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getOpenApi");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        try {
            apiInstance.getOpenApi();
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getOpenApi");
            e.printStackTrace();
        }
    }
}

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

// Return the OpenAPI specification for the Data Product API.  Use a Content-Type of 'application/yaml' to request a YAML response instead of JSON.
[apiInstance getOpenApiWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getOpenApi(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();

            try
            {
                // Return the OpenAPI specification for the Data Product API.  Use a Content-Type of 'application/yaml' to request a YAML response instead of JSON.
                apiInstance.getOpenApi();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.getOpenApi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();

eval { 
    $api_instance->getOpenApi();
};
if ($@) {
    warn "Exception when calling DataProductsApi->getOpenApi: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()

try: 
    # Return the OpenAPI specification for the Data Product API.  Use a Content-Type of 'application/yaml' to request a YAML response instead of JSON.
    api_instance.get_open_api()
except ApiException as e:
    print("Exception when calling DataProductsApi->getOpenApi: %s\n" % e)

Parameters

Responses

Status: 200 - Success


getTargetCatalogs

Return all catalogs suitable to store data products


/api/v1/dataProduct/catalogs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/catalogs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        try {
            array[Catalog details] result = apiInstance.getTargetCatalogs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getTargetCatalogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        try {
            array[Catalog details] result = apiInstance.getTargetCatalogs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getTargetCatalogs");
            e.printStackTrace();
        }
    }
}

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

// Return all catalogs suitable to store data products
[apiInstance getTargetCatalogsWithCompletionHandler: 
              ^(array[Catalog details] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTargetCatalogs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();

            try
            {
                // Return all catalogs suitable to store data products
                array[Catalog details] result = apiInstance.getTargetCatalogs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.getTargetCatalogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()

try: 
    # Return all catalogs suitable to store data products
    api_response = api_instance.get_target_catalogs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->getTargetCatalogs: %s\n" % e)

Parameters

Responses

Status: 200 - Success


listSampleQueries

Get the sample queries for a data product


/api/v1/dataProduct/products/{dataProductId}/sampleQueries

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/sampleQueries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            array[SampleQuery] result = apiInstance.listSampleQueries(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#listSampleQueries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            array[SampleQuery] result = apiInstance.listSampleQueries(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#listSampleQueries");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Get the sample queries for a data product
[apiInstance listSampleQueriesWith:dataProductId
              completionHandler: ^(array[SampleQuery] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSampleQueries(dataProductId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var dataProductId = new UUID(); // UUID | 

            try
            {
                // Get the sample queries for a data product
                array[SampleQuery] result = apiInstance.listSampleQueries(dataProductId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.listSampleQueries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Get the sample queries for a data product
    api_response = api_instance.list_sample_queries(dataProductId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->listSampleQueries: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Status: 403 - Forbidden


reassignDomainForDataProducts

Reassign the domain for a list of data products


/api/v1/dataProduct/products/reassignDomain

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products/reassignDomain"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        DomainReassignmentRequest body = ; // DomainReassignmentRequest | 
        try {
            apiInstance.reassignDomainForDataProducts(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#reassignDomainForDataProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        DomainReassignmentRequest body = ; // DomainReassignmentRequest | 
        try {
            apiInstance.reassignDomainForDataProducts(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#reassignDomainForDataProducts");
            e.printStackTrace();
        }
    }
}
DomainReassignmentRequest *body = ; //  (optional)

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

// Reassign the domain for a list of data products
[apiInstance reassignDomainForDataProductsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var opts = { 
  'body':  // {{DomainReassignmentRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.reassignDomainForDataProducts(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var body = new DomainReassignmentRequest(); // DomainReassignmentRequest |  (optional) 

            try
            {
                // Reassign the domain for a list of data products
                apiInstance.reassignDomainForDataProducts(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.reassignDomainForDataProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$body = ; // DomainReassignmentRequest | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $body = WWW::SwaggerClient::Object::DomainReassignmentRequest->new(); # DomainReassignmentRequest | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
body =  # DomainReassignmentRequest |  (optional)

try: 
    # Reassign the domain for a list of data products
    api_instance.reassign_domain_for_data_products(body=body)
except ApiException as e:
    print("Exception when calling DataProductsApi->reassignDomainForDataProducts: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 204 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found


searchDataProducts

Search for data products according to the searchOptions request parameter.

This endpoint returns the first 100 data products matching the given searchOptions parameter. The number of results can be configured in the limit attribute of the searchOptions, up to a maximum of 1000.


/api/v1/dataProduct/products

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/products?searchOptions="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        SearchOptionsParam searchOptions = ; // SearchOptionsParam | 
        try {
            array[Data product summary] result = apiInstance.searchDataProducts(searchOptions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#searchDataProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        SearchOptionsParam searchOptions = ; // SearchOptionsParam | 
        try {
            array[Data product summary] result = apiInstance.searchDataProducts(searchOptions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#searchDataProducts");
            e.printStackTrace();
        }
    }
}
SearchOptionsParam *searchOptions = ; //  (optional)

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

// Search for data products according to the searchOptions request parameter.
[apiInstance searchDataProductsWith:searchOptions
              completionHandler: ^(array[Data product summary] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var opts = { 
  'searchOptions':  // {{SearchOptionsParam}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchDataProducts(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var searchOptions = new SearchOptionsParam(); // SearchOptionsParam |  (optional) 

            try
            {
                // Search for data products according to the searchOptions request parameter.
                array[Data product summary] result = apiInstance.searchDataProducts(searchOptions);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.searchDataProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$searchOptions = ; // SearchOptionsParam | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $searchOptions = ; # SearchOptionsParam | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
searchOptions =  # SearchOptionsParam |  (optional)

try: 
    # Search for data products according to the searchOptions request parameter.
    api_response = api_instance.search_data_products(searchOptions=searchOptions)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->searchDataProducts: %s\n" % e)

Parameters

Query parameters
Name Description
searchOptions
SearchOptionsParam

Responses

Status: 200 - Success


updateDataProduct

Update a data product


/api/v1/dataProduct/products/{dataProductId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products/{dataProductId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        DataProductPayload body = ; // DataProductPayload | 
        try {
            Data product result = apiInstance.updateDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateDataProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        DataProductPayload body = ; // DataProductPayload | 
        try {
            Data product result = apiInstance.updateDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateDataProduct");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
DataProductPayload *body = ; //  (optional)

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

// Update a data product
[apiInstance updateDataProductWith:dataProductId
    body:body
              completionHandler: ^(Data product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'body':  // {{DataProductPayload}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDataProduct(dataProductId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var dataProductId = new UUID(); // UUID | 
            var body = new DataProductPayload(); // DataProductPayload |  (optional) 

            try
            {
                // Update a data product
                Data product result = apiInstance.updateDataProduct(dataProductId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.updateDataProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = ; // DataProductPayload | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = WWW::SwaggerClient::Object::DataProductPayload->new(); # DataProductPayload | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
body =  # DataProductPayload |  (optional)

try: 
    # Update a data product
    api_response = api_instance.update_data_product(dataProductId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->updateDataProduct: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found

Status: 409 - Conflict


updateSampleQueries

Update sample queries for a data product


/api/v1/dataProduct/products/{dataProductId}/sampleQueries

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/sampleQueries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataProductsApi;

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

public class DataProductsApiExample {

    public static void main(String[] args) {
        
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        array[SampleQuery] body = ; // array[SampleQuery] | 
        try {
            apiInstance.updateSampleQueries(dataProductId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateSampleQueries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataProductsApi;

public class DataProductsApiExample {

    public static void main(String[] args) {
        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        array[SampleQuery] body = ; // array[SampleQuery] | 
        try {
            apiInstance.updateSampleQueries(dataProductId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateSampleQueries");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
array[SampleQuery] *body = ; //  (optional)

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

// Update sample queries for a data product
[apiInstance updateSampleQueriesWith:dataProductId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'body':  // {{array[SampleQuery]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateSampleQueries(dataProductId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataProductsApi();
            var dataProductId = new UUID(); // UUID | 
            var body = new array[SampleQuery](); // array[SampleQuery] |  (optional) 

            try
            {
                // Update sample queries for a data product
                apiInstance.updateSampleQueries(dataProductId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataProductsApi.updateSampleQueries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = ; // array[SampleQuery] | 

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

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = [WWW::SwaggerClient::Object::array[SampleQuery]->new()]; # array[SampleQuery] | 

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

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
body =  # array[SampleQuery] |  (optional)

try: 
    # Update sample queries for a data product
    api_instance.update_sample_queries(dataProductId, body=body)
except ApiException as e:
    print("Exception when calling DataProductsApi->updateSampleQueries: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
Body parameters
Name Description
body

Responses

Status: 204 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found


Domains

createDomain

Create a data product domain


/api/v1/dataProduct/domains

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/domains"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomainsApi;

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

public class DomainsApiExample {

    public static void main(String[] args) {
        
        DomainsApi apiInstance = new DomainsApi();
        CreateDataDomainRequest body = ; // CreateDataDomainRequest | 
        try {
            Data domain result = apiInstance.createDomain(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#createDomain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomainsApi;

public class DomainsApiExample {

    public static void main(String[] args) {
        DomainsApi apiInstance = new DomainsApi();
        CreateDataDomainRequest body = ; // CreateDataDomainRequest | 
        try {
            Data domain result = apiInstance.createDomain(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#createDomain");
            e.printStackTrace();
        }
    }
}
CreateDataDomainRequest *body = ; //  (optional)

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

// Create a data product domain
[apiInstance createDomainWith:body
              completionHandler: ^(Data domain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DomainsApi()
var opts = { 
  'body':  // {{CreateDataDomainRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomain(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DomainsApi();
            var body = new CreateDataDomainRequest(); // CreateDataDomainRequest |  (optional) 

            try
            {
                // Create a data product domain
                Data domain result = apiInstance.createDomain(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomainsApi.createDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDomainsApi();
$body = ; // CreateDataDomainRequest | 

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

my $api_instance = WWW::SwaggerClient::DomainsApi->new();
my $body = WWW::SwaggerClient::Object::CreateDataDomainRequest->new(); # CreateDataDomainRequest | 

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

# create an instance of the API class
api_instance = swagger_client.DomainsApi()
body =  # CreateDataDomainRequest |  (optional)

try: 
    # Create a data product domain
    api_response = api_instance.create_domain(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomainsApi->createDomain: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden


deleteDomain

Delete a data product domain


/api/v1/dataProduct/domains/{dataDomainId}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v1/dataProduct/domains/{dataDomainId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomainsApi;

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

public class DomainsApiExample {

    public static void main(String[] args) {
        
        DomainsApi apiInstance = new DomainsApi();
        UUID dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            apiInstance.deleteDomain(dataDomainId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#deleteDomain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomainsApi;

public class DomainsApiExample {

    public static void main(String[] args) {
        DomainsApi apiInstance = new DomainsApi();
        UUID dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            apiInstance.deleteDomain(dataDomainId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#deleteDomain");
            e.printStackTrace();
        }
    }
}
UUID *dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Delete a data product domain
[apiInstance deleteDomainWith:dataDomainId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DomainsApi()
var dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDomain(dataDomainId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DomainsApi();
            var dataDomainId = new UUID(); // UUID | 

            try
            {
                // Delete a data product domain
                apiInstance.deleteDomain(dataDomainId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomainsApi.deleteDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDomainsApi();
$dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::DomainsApi->new();
my $dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval { 
    $api_instance->deleteDomain(dataDomainId => $dataDomainId);
};
if ($@) {
    warn "Exception when calling DomainsApi->deleteDomain: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DomainsApi()
dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Delete a data product domain
    api_instance.delete_domain(dataDomainId)
except ApiException as e:
    print("Exception when calling DomainsApi->deleteDomain: %s\n" % e)

Parameters

Path parameters
Name Description
dataDomainId*
UUID (uuid)
Required

Responses

Status: 204 - Success

Status: 403 - Forbidden

Status: 404 - Not found


getDomain

Get a data product domain by identifier


/api/v1/dataProduct/domains/{dataDomainId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/domains/{dataDomainId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomainsApi;

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

public class DomainsApiExample {

    public static void main(String[] args) {
        
        DomainsApi apiInstance = new DomainsApi();
        UUID dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            Data domain result = apiInstance.getDomain(dataDomainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#getDomain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomainsApi;

public class DomainsApiExample {

    public static void main(String[] args) {
        DomainsApi apiInstance = new DomainsApi();
        UUID dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            Data domain result = apiInstance.getDomain(dataDomainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#getDomain");
            e.printStackTrace();
        }
    }
}
UUID *dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Get a data product domain by identifier
[apiInstance getDomainWith:dataDomainId
              completionHandler: ^(Data domain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DomainsApi()
var dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomain(dataDomainId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DomainsApi();
            var dataDomainId = new UUID(); // UUID | 

            try
            {
                // Get a data product domain by identifier
                Data domain result = apiInstance.getDomain(dataDomainId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomainsApi.getDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDomainsApi();
$dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::DomainsApi->new();
my $dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.DomainsApi()
dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Get a data product domain by identifier
    api_response = api_instance.get_domain(dataDomainId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomainsApi->getDomain: %s\n" % e)

Parameters

Path parameters
Name Description
dataDomainId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Status: 403 - Forbidden

Status: 404 - Not found


listDomains

List all data product domains


/api/v1/dataProduct/domains

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/domains"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomainsApi;

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

public class DomainsApiExample {

    public static void main(String[] args) {
        
        DomainsApi apiInstance = new DomainsApi();
        try {
            array[Data domain] result = apiInstance.listDomains();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#listDomains");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomainsApi;

public class DomainsApiExample {

    public static void main(String[] args) {
        DomainsApi apiInstance = new DomainsApi();
        try {
            array[Data domain] result = apiInstance.listDomains();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#listDomains");
            e.printStackTrace();
        }
    }
}

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

// List all data product domains
[apiInstance listDomainsWithCompletionHandler: 
              ^(array[Data domain] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DomainsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDomains(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DomainsApi();

            try
            {
                // List all data product domains
                array[Data domain] result = apiInstance.listDomains();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomainsApi.listDomains: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDomainsApi();

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

my $api_instance = WWW::SwaggerClient::DomainsApi->new();

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

# create an instance of the API class
api_instance = swagger_client.DomainsApi()

try: 
    # List all data product domains
    api_response = api_instance.list_domains()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomainsApi->listDomains: %s\n" % e)

Parameters

Responses

Status: 200 - Success


updateDomain

Update a data product domain


/api/v1/dataProduct/domains/{dataDomainId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/domains/{dataDomainId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomainsApi;

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

public class DomainsApiExample {

    public static void main(String[] args) {
        
        DomainsApi apiInstance = new DomainsApi();
        UUID dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UpdateDataDomainRequest body = ; // UpdateDataDomainRequest | 
        try {
            Data domain result = apiInstance.updateDomain(dataDomainId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#updateDomain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomainsApi;

public class DomainsApiExample {

    public static void main(String[] args) {
        DomainsApi apiInstance = new DomainsApi();
        UUID dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UpdateDataDomainRequest body = ; // UpdateDataDomainRequest | 
        try {
            Data domain result = apiInstance.updateDomain(dataDomainId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomainsApi#updateDomain");
            e.printStackTrace();
        }
    }
}
UUID *dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
UpdateDataDomainRequest *body = ; //  (optional)

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

// Update a data product domain
[apiInstance updateDomainWith:dataDomainId
    body:body
              completionHandler: ^(Data domain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.DomainsApi()
var dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'body':  // {{UpdateDataDomainRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDomain(dataDomainId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DomainsApi();
            var dataDomainId = new UUID(); // UUID | 
            var body = new UpdateDataDomainRequest(); // UpdateDataDomainRequest |  (optional) 

            try
            {
                // Update a data product domain
                Data domain result = apiInstance.updateDomain(dataDomainId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomainsApi.updateDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDomainsApi();
$dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = ; // UpdateDataDomainRequest | 

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

my $api_instance = WWW::SwaggerClient::DomainsApi->new();
my $dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = WWW::SwaggerClient::Object::UpdateDataDomainRequest->new(); # UpdateDataDomainRequest | 

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

# create an instance of the API class
api_instance = swagger_client.DomainsApi()
dataDomainId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
body =  # UpdateDataDomainRequest |  (optional)

try: 
    # Update a data product domain
    api_response = api_instance.update_domain(dataDomainId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomainsApi->updateDomain: %s\n" % e)

Parameters

Path parameters
Name Description
dataDomainId*
UUID (uuid)
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found


Tags

deleteAllUnusedTags

Delete all unused tags


/api/v1/dataProduct/tags/unused

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v1/dataProduct/tags/unused"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        try {
            apiInstance.deleteAllUnusedTags();
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteAllUnusedTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        try {
            apiInstance.deleteAllUnusedTags();
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteAllUnusedTags");
            e.printStackTrace();
        }
    }
}

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

// Delete all unused tags
[apiInstance deleteAllUnusedTagsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllUnusedTags(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TagsApi();

            try
            {
                // Delete all unused tags
                apiInstance.deleteAllUnusedTags();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.deleteAllUnusedTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();

eval { 
    $api_instance->deleteAllUnusedTags();
};
if ($@) {
    warn "Exception when calling TagsApi->deleteAllUnusedTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()

try: 
    # Delete all unused tags
    api_instance.delete_all_unused_tags()
except ApiException as e:
    print("Exception when calling TagsApi->deleteAllUnusedTags: %s\n" % e)

Parameters

Responses

Status: 204 - Success


deleteDataProductTag

Delete a tag from a specific data product


/api/v1/dataProduct/tags/{tagId}/products/{dataProductId}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,*/*"\
"//api/v1/dataProduct/tags/{tagId}/products/{dataProductId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        UUID tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            apiInstance.deleteDataProductTag(tagId, dataProductId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteDataProductTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        UUID tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            apiInstance.deleteDataProductTag(tagId, dataProductId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteDataProductTag");
            e.printStackTrace();
        }
    }
}
UUID *tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Delete a tag from a specific data product
[apiInstance deleteDataProductTagWith:tagId
    dataProductId:dataProductId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataProductTag(tagId, dataProductId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TagsApi();
            var tagId = new UUID(); // UUID | 
            var dataProductId = new UUID(); // UUID | 

            try
            {
                // Delete a tag from a specific data product
                apiInstance.deleteDataProductTag(tagId, dataProductId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.deleteDataProductTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();
$tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->deleteDataProductTag($tagId, $dataProductId);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->deleteDataProductTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()
tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Delete a tag from a specific data product
    api_instance.delete_data_product_tag(tagId, dataProductId)
except ApiException as e:
    print("Exception when calling TagsApi->deleteDataProductTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
UUID (uuid)
Required
dataProductId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Status: 403 - Forbidden

Status: 404 - Not found


deleteTag

Delete an unused tag with a specific identifier


/api/v1/dataProduct/tags/{tagId}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,*/*"\
"//api/v1/dataProduct/tags/{tagId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        UUID tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            apiInstance.deleteTag(tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        UUID tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            apiInstance.deleteTag(tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteTag");
            e.printStackTrace();
        }
    }
}
UUID *tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Delete an unused tag with a specific identifier
[apiInstance deleteTagWith:tagId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
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()
        {

            var apiInstance = new TagsApi();
            var tagId = new UUID(); // UUID | 

            try
            {
                // Delete an unused tag with a specific identifier
                apiInstance.deleteTag(tagId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.deleteTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();
$tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval { 
    $api_instance->deleteTag(tagId => $tagId);
};
if ($@) {
    warn "Exception when calling TagsApi->deleteTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Delete an unused tag with a specific identifier
    api_instance.delete_tag(tagId)
except ApiException as e:
    print("Exception when calling TagsApi->deleteTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
UUID (uuid)
Required

Responses

Status: 204 - Success

Status: 403 - Forbidden

Status: 404 - Not found


getDataProductTags

List all tags associated with a specific data product


/api/v1/dataProduct/tags/products/{dataProductId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/tags/products/{dataProductId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            array[DataProductTag] result = apiInstance.getDataProductTags(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#getDataProductTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            array[DataProductTag] result = apiInstance.getDataProductTags(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#getDataProductTags");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// List all tags associated with a specific data product
[apiInstance getDataProductTagsWith:dataProductId
              completionHandler: ^(array[DataProductTag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataProductTags(dataProductId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TagsApi();
            var dataProductId = new UUID(); // UUID | 

            try
            {
                // List all tags associated with a specific data product
                array[DataProductTag] result = apiInstance.getDataProductTags(dataProductId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.getDataProductTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # List all tags associated with a specific data product
    api_response = api_instance.get_data_product_tags(dataProductId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->getDataProductTags: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Status: 403 - Forbidden

Status: 404 - Not found


listTags

List all available tags for all data products


/api/v1/dataProduct/tags

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        try {
            array[DataProductTag] result = apiInstance.listTags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#listTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        try {
            array[DataProductTag] result = apiInstance.listTags();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#listTags");
            e.printStackTrace();
        }
    }
}

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

// List all available tags for all data products
[apiInstance listTagsWithCompletionHandler: 
              ^(array[DataProductTag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listTags(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TagsApi();

            try
            {
                // List all available tags for all data products
                array[DataProductTag] result = apiInstance.listTags();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.listTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()

try: 
    # List all available tags for all data products
    api_response = api_instance.list_tags()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->listTags: %s\n" % e)

Parameters

Responses

Status: 200 - Success


updateDataProductTags

Replace all tags for a specific data product with the supplied list of new tags


/api/v1/dataProduct/tags/products/{dataProductId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/tags/products/{dataProductId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        array[DataProductTagValue] body = ; // array[DataProductTagValue] | 
        try {
            array[DataProductTag] result = apiInstance.updateDataProductTags(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#updateDataProductTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        array[DataProductTagValue] body = ; // array[DataProductTagValue] | 
        try {
            array[DataProductTag] result = apiInstance.updateDataProductTags(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#updateDataProductTags");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
array[DataProductTagValue] *body = ; //  (optional)

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

// Replace all tags for a specific data product with the supplied list of new tags
[apiInstance updateDataProductTagsWith:dataProductId
    body:body
              completionHandler: ^(array[DataProductTag] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'body':  // {{array[DataProductTagValue]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDataProductTags(dataProductId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TagsApi();
            var dataProductId = new UUID(); // UUID | 
            var body = new array[DataProductTagValue](); // array[DataProductTagValue] |  (optional) 

            try
            {
                // Replace all tags for a specific data product with the supplied list of new tags
                array[DataProductTag] result = apiInstance.updateDataProductTags(dataProductId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.updateDataProductTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = ; // array[DataProductTagValue] | 

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = [WWW::SwaggerClient::Object::array[DataProductTagValue]->new()]; # array[DataProductTagValue] | 

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
body =  # array[DataProductTagValue] |  (optional)

try: 
    # Replace all tags for a specific data product with the supplied list of new tags
    api_response = api_instance.update_data_product_tags(dataProductId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->updateDataProductTags: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
Body parameters
Name Description
body

Responses

Status: 204 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found


updateTag

Update a specific tag


/api/v1/dataProduct/tags/{tagId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json,*/*"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/tags/{tagId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        UUID tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        DataProductTagValue body = ; // DataProductTagValue | 
        try {
            apiInstance.updateTag(tagId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#updateTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        UUID tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        DataProductTagValue body = ; // DataProductTagValue | 
        try {
            apiInstance.updateTag(tagId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#updateTag");
            e.printStackTrace();
        }
    }
}
UUID *tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
DataProductTagValue *body = ; //  (optional)

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

// Update a specific tag
[apiInstance updateTagWith:tagId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.TagsApi()
var tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'body':  // {{DataProductTagValue}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateTag(tagId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TagsApi();
            var tagId = new UUID(); // UUID | 
            var body = new DataProductTagValue(); // DataProductTagValue |  (optional) 

            try
            {
                // Update a specific tag
                apiInstance.updateTag(tagId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.updateTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTagsApi();
$tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = ; // DataProductTagValue | 

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = WWW::SwaggerClient::Object::DataProductTagValue->new(); # DataProductTagValue | 

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()
tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
body =  # DataProductTagValue |  (optional)

try: 
    # Update a specific tag
    api_instance.update_tag(tagId, body=body)
except ApiException as e:
    print("Exception when calling TagsApi->updateTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
UUID (uuid)
Required
Body parameters
Name Description
body

Responses

Status: 204 - Success

Status: 400 - Bad Request

Status: 403 - Forbidden

Status: 404 - Not found


Workflows

deleteDataProduct

Initiate an asynchronous task to delete the data product.

This workflow attempts to delete the data product's schema and its views, or materialized views, from the underlying storage system. If the deletion succeeds the data product metadata is also deleted. This endpoint returns a success response if the async task is accepted by the server. Clients must poll the endpoint returned in the location header in order to follow the status of the async operation.


/api/v1/dataProduct/products/{dataProductId}/workflows/delete

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,*/*"\
"//api/v1/dataProduct/products/{dataProductId}/workflows/delete?skipTrinoDelete="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowsApi;

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

public class WorkflowsApiExample {

    public static void main(String[] args) {
        
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean skipTrinoDelete = true; // Boolean | If true, just delete from the data product DB, don't delete any tables or schemas from Trino
        try {
            apiInstance.deleteDataProduct(dataProductId, skipTrinoDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#deleteDataProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

    public static void main(String[] args) {
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean skipTrinoDelete = true; // Boolean | If true, just delete from the data product DB, don't delete any tables or schemas from Trino
        try {
            apiInstance.deleteDataProduct(dataProductId, skipTrinoDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#deleteDataProduct");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
Boolean *skipTrinoDelete = true; // If true, just delete from the data product DB, don't delete any tables or schemas from Trino (optional)

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

// Initiate an asynchronous task to delete the data product.
[apiInstance deleteDataProductWith:dataProductId
    skipTrinoDelete:skipTrinoDelete
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.WorkflowsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'skipTrinoDelete': true // {{Boolean}} If true, just delete from the data product DB, don't delete any tables or schemas from Trino
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataProduct(dataProductId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new WorkflowsApi();
            var dataProductId = new UUID(); // UUID | 
            var skipTrinoDelete = true;  // Boolean | If true, just delete from the data product DB, don't delete any tables or schemas from Trino (optional) 

            try
            {
                // Initiate an asynchronous task to delete the data product.
                apiInstance.deleteDataProduct(dataProductId, skipTrinoDelete);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.deleteDataProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWorkflowsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$skipTrinoDelete = true; // Boolean | If true, just delete from the data product DB, don't delete any tables or schemas from Trino

try {
    $api_instance->deleteDataProduct($dataProductId, $skipTrinoDelete);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowsApi->deleteDataProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowsApi;

my $api_instance = WWW::SwaggerClient::WorkflowsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $skipTrinoDelete = true; # Boolean | If true, just delete from the data product DB, don't delete any tables or schemas from Trino

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

# create an instance of the API class
api_instance = swagger_client.WorkflowsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
skipTrinoDelete = true # Boolean | If true, just delete from the data product DB, don't delete any tables or schemas from Trino (optional)

try: 
    # Initiate an asynchronous task to delete the data product.
    api_instance.delete_data_product(dataProductId, skipTrinoDelete=skipTrinoDelete)
except ApiException as e:
    print("Exception when calling WorkflowsApi->deleteDataProduct: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
Query parameters
Name Description
skipTrinoDelete
Boolean
If true, just delete from the data product DB, don't delete any tables or schemas from Trino

Responses

Status: 202 - Accepted

Name Type Format Description
Location String URL The endpoint to poll in order to GET the status of the operation.

Status: 403 - Forbidden

Status: 404 - Not found


getDeleteDataProductStatus

Get the status of the async task to delete a data product.

Clients must poll this endpoint until the attribute isFinalStatus in the response body is true.


/api/v1/dataProduct/products/{dataProductId}/workflows/delete

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/workflows/delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowsApi;

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

public class WorkflowsApiExample {

    public static void main(String[] args) {
        
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            DataProductWorkflowState result = apiInstance.getDeleteDataProductStatus(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getDeleteDataProductStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

    public static void main(String[] args) {
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            DataProductWorkflowState result = apiInstance.getDeleteDataProductStatus(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getDeleteDataProductStatus");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Get the status of the async task to delete a data product.
[apiInstance getDeleteDataProductStatusWith:dataProductId
              completionHandler: ^(DataProductWorkflowState output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.WorkflowsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeleteDataProductStatus(dataProductId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new WorkflowsApi();
            var dataProductId = new UUID(); // UUID | 

            try
            {
                // Get the status of the async task to delete a data product.
                DataProductWorkflowState result = apiInstance.getDeleteDataProductStatus(dataProductId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.getDeleteDataProductStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWorkflowsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::WorkflowsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.WorkflowsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Get the status of the async task to delete a data product.
    api_response = api_instance.get_delete_data_product_status(dataProductId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->getDeleteDataProductStatus: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Name Type Format Description
Location String URL The endpoint to poll in order to GET the status of the operation

Status: 403 - Forbidden

Status: 404 - No delete tasks are being processed for the data product


getPublishDataProductStatus

Get the status of the async task that publishes a data product.

Clients must poll this endpoint until the attribute isFinalStatus in the response body is true.


/api/v1/dataProduct/products/{dataProductId}/workflows/publish

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/workflows/publish"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowsApi;

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

public class WorkflowsApiExample {

    public static void main(String[] args) {
        
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            DataProductWorkflowState result = apiInstance.getPublishDataProductStatus(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getPublishDataProductStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

    public static void main(String[] args) {
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        try {
            DataProductWorkflowState result = apiInstance.getPublishDataProductStatus(dataProductId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getPublishDataProductStatus");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 

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

// Get the status of the async task that publishes a data product.
[apiInstance getPublishDataProductStatusWith:dataProductId
              completionHandler: ^(DataProductWorkflowState output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.WorkflowsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublishDataProductStatus(dataProductId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new WorkflowsApi();
            var dataProductId = new UUID(); // UUID | 

            try
            {
                // Get the status of the async task that publishes a data product.
                DataProductWorkflowState result = apiInstance.getPublishDataProductStatus(dataProductId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.getPublishDataProductStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWorkflowsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

my $api_instance = WWW::SwaggerClient::WorkflowsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# create an instance of the API class
api_instance = swagger_client.WorkflowsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 

try: 
    # Get the status of the async task that publishes a data product.
    api_response = api_instance.get_publish_data_product_status(dataProductId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->getPublishDataProductStatus: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required

Responses

Status: 200 - Success

Name Type Format Description
Location String URL The endpoint to poll in order to GET the status of the operation. If task is finished, this will return endpoint for getting the data product.

Status: 403 - Forbidden

Status: 404 - No publish tasks are being processed for the data product


publishDataProduct

Publish the data product by initiating an asynchronous task to populate the views, or materialized views, in the schema.

The publish workflow creates the data product as a schema in the data product's catalog using the domain schema location if provided, or the catalog's default schema location. The datasets are created as views or materialized views in that schema, according to their types. If completed successfully, the data product status transitions to PUBLISHED. This endpoint returns a success response if the async task is accepted by the server. Clients must poll the endpoint returned in the location header in order to follow the status of the async operation.


/api/v1/dataProduct/products/{dataProductId}/workflows/publish

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,*/*"\
"//api/v1/dataProduct/products/{dataProductId}/workflows/publish?force="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowsApi;

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

public class WorkflowsApiExample {

    public static void main(String[] args) {
        
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | If true the data product will be republished, even if it is already published, and all its datasets will be recreated
        try {
            apiInstance.publishDataProduct(dataProductId, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#publishDataProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

    public static void main(String[] args) {
        WorkflowsApi apiInstance = new WorkflowsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | If true the data product will be republished, even if it is already published, and all its datasets will be recreated
        try {
            apiInstance.publishDataProduct(dataProductId, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#publishDataProduct");
            e.printStackTrace();
        }
    }
}
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
Boolean *force = true; // If true the data product will be republished, even if it is already published, and all its datasets will be recreated (optional)

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

// Publish the data product by initiating an asynchronous task to populate the views, or materialized views, in the schema.
[apiInstance publishDataProductWith:dataProductId
    force:force
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');

var api = new StarburstEnterpriseApiDocumentation.WorkflowsApi()
var dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'force': true // {{Boolean}} If true the data product will be republished, even if it is already published, and all its datasets will be recreated
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.publishDataProduct(dataProductId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new WorkflowsApi();
            var dataProductId = new UUID(); // UUID | 
            var force = true;  // Boolean | If true the data product will be republished, even if it is already published, and all its datasets will be recreated (optional) 

            try
            {
                // Publish the data product by initiating an asynchronous task to populate the views, or materialized views, in the schema.
                apiInstance.publishDataProduct(dataProductId, force);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.publishDataProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWorkflowsApi();
$dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$force = true; // Boolean | If true the data product will be republished, even if it is already published, and all its datasets will be recreated

try {
    $api_instance->publishDataProduct($dataProductId, $force);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowsApi->publishDataProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkflowsApi;

my $api_instance = WWW::SwaggerClient::WorkflowsApi->new();
my $dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $force = true; # Boolean | If true the data product will be republished, even if it is already published, and all its datasets will be recreated

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

# create an instance of the API class
api_instance = swagger_client.WorkflowsApi()
dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
force = true # Boolean | If true the data product will be republished, even if it is already published, and all its datasets will be recreated (optional)

try: 
    # Publish the data product by initiating an asynchronous task to populate the views, or materialized views, in the schema.
    api_instance.publish_data_product(dataProductId, force=force)
except ApiException as e:
    print("Exception when calling WorkflowsApi->publishDataProduct: %s\n" % e)

Parameters

Path parameters
Name Description
dataProductId*
UUID (uuid)
Required
Query parameters
Name Description
force
Boolean
If true the data product will be republished, even if it is already published, and all its datasets will be recreated

Responses

Status: 202 - Accepted

Name Type Format Description
Location String URL The endpoint to poll in order to GET the status of the operation.

Status: 403 - Forbidden

Status: 404 - Not found