Starburst Enterprise API documentation

AuditLogs

listAccessLogs

List Starburst built-in access control access logs


/api/v1/biac/audit/accessLogs

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/audit/accessLogs?pageToken=&pageSize=&pageSort=&startDate=&endDate=&queryId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditLogsApi;

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

public class AuditLogsApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        AuditLogsApi apiInstance = new AuditLogsApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
        Date queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
        try {
            PaginatedResultAccessLogResponse result = apiInstance.listAccessLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#listAccessLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuditLogsApi;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        AuditLogsApi apiInstance = new AuditLogsApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
        Date queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
        try {
            PaginatedResultAccessLogResponse result = apiInstance.listAccessLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#listAccessLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pageToken = pageToken_example; // Page token (optional)
String *pageSize = pageSize_example; // Page size (optional) (default to 100)
String *pageSort = pageSort_example; // Sorting order (optional) (default to desc)
Date *startDate = 2013-10-20T19:20:30+01:00; // Start of the log entry timestamp interval to match (inclusive) (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // End of the log entry timestamp interval to match (exclusive) (optional)
Date *queryId = 2013-10-20T19:20:30+01:00; // Query ID for which log entries should be matched (optional)

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

// List Starburst built-in access control access logs
[apiInstance listAccessLogsWith:pageToken
    pageSize:pageSize
    pageSort:pageSort
    startDate:startDate
    endDate:endDate
    queryId:queryId
              completionHandler: ^(PaginatedResultAccessLogResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.AuditLogsApi()
var opts = { 
  'pageToken': pageToken_example, // {{String}} Page token
  'pageSize': pageSize_example, // {{String}} Page size
  'pageSort': pageSort_example, // {{String}} Sorting order
  'startDate': 2013-10-20T19:20:30+01:00, // {{Date}} Start of the log entry timestamp interval to match (inclusive)
  'endDate': 2013-10-20T19:20:30+01:00, // {{Date}} End of the log entry timestamp interval to match (exclusive)
  'queryId': 2013-10-20T19:20:30+01:00 // {{Date}} Query ID for which log entries should be matched
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAccessLogs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AuditLogsApi();
            var pageToken = pageToken_example;  // String | Page token (optional) 
            var pageSize = pageSize_example;  // String | Page size (optional)  (default to 100)
            var pageSort = pageSort_example;  // String | Sorting order (optional)  (default to desc)
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | Start of the log entry timestamp interval to match (inclusive) (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | End of the log entry timestamp interval to match (exclusive) (optional) 
            var queryId = 2013-10-20T19:20:30+01:00;  // Date | Query ID for which log entries should be matched (optional) 

            try
            {
                // List Starburst built-in access control access logs
                PaginatedResultAccessLogResponse result = apiInstance.listAccessLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuditLogsApi.listAccessLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAuditLogsApi();
$pageToken = pageToken_example; // String | Page token
$pageSize = pageSize_example; // String | Page size
$pageSort = pageSort_example; // String | Sorting order
$startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
$endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
$queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched

try {
    $result = $api_instance->listAccessLogs($pageToken, $pageSize, $pageSort, $startDate, $endDate, $queryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditLogsApi->listAccessLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditLogsApi;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AuditLogsApi->new();
my $pageToken = pageToken_example; # String | Page token
my $pageSize = pageSize_example; # String | Page size
my $pageSort = pageSort_example; # String | Sorting order
my $startDate = 2013-10-20T19:20:30+01:00; # Date | Start of the log entry timestamp interval to match (inclusive)
my $endDate = 2013-10-20T19:20:30+01:00; # Date | End of the log entry timestamp interval to match (exclusive)
my $queryId = 2013-10-20T19:20:30+01:00; # Date | Query ID for which log entries should be matched

eval { 
    my $result = $api_instance->listAccessLogs(pageToken => $pageToken, pageSize => $pageSize, pageSort => $pageSort, startDate => $startDate, endDate => $endDate, queryId => $queryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditLogsApi->listAccessLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AuditLogsApi()
pageToken = pageToken_example # String | Page token (optional)
pageSize = pageSize_example # String | Page size (optional) (default to 100)
pageSort = pageSort_example # String | Sorting order (optional) (default to desc)
startDate = 2013-10-20T19:20:30+01:00 # Date | Start of the log entry timestamp interval to match (inclusive) (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | End of the log entry timestamp interval to match (exclusive) (optional)
queryId = 2013-10-20T19:20:30+01:00 # Date | Query ID for which log entries should be matched (optional)

try: 
    # List Starburst built-in access control access logs
    api_response = api_instance.list_access_logs(pageToken=pageToken, pageSize=pageSize, pageSort=pageSort, startDate=startDate, endDate=endDate, queryId=queryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditLogsApi->listAccessLogs: %s\n" % e)

Parameters

Query parameters
Name Description
pageToken
String
Page token
pageSize
String
Page size
pageSort
String
Sorting order
startDate
Date (date-time)
Start of the log entry timestamp interval to match (inclusive)
endDate
Date (date-time)
End of the log entry timestamp interval to match (exclusive)
queryId
Date (date-time)
Query ID for which log entries should be matched

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden


listChangeLogs

List Starburst built-in access control change logs


/api/v1/biac/audit/changeLogs

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/audit/changeLogs?pageToken=&pageSize=&pageSort=&startDate=&endDate=&queryId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditLogsApi;

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

public class AuditLogsApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        AuditLogsApi apiInstance = new AuditLogsApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
        Date queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
        try {
            PaginatedResultChangeLogResponse result = apiInstance.listChangeLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#listChangeLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuditLogsApi;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        AuditLogsApi apiInstance = new AuditLogsApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
        Date queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched
        try {
            PaginatedResultChangeLogResponse result = apiInstance.listChangeLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#listChangeLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pageToken = pageToken_example; // Page token (optional)
String *pageSize = pageSize_example; // Page size (optional) (default to 100)
String *pageSort = pageSort_example; // Sorting order (optional) (default to desc)
Date *startDate = 2013-10-20T19:20:30+01:00; // Start of the log entry timestamp interval to match (inclusive) (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // End of the log entry timestamp interval to match (exclusive) (optional)
Date *queryId = 2013-10-20T19:20:30+01:00; // Query ID for which log entries should be matched (optional)

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

// List Starburst built-in access control change logs
[apiInstance listChangeLogsWith:pageToken
    pageSize:pageSize
    pageSort:pageSort
    startDate:startDate
    endDate:endDate
    queryId:queryId
              completionHandler: ^(PaginatedResultChangeLogResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.AuditLogsApi()
var opts = { 
  'pageToken': pageToken_example, // {{String}} Page token
  'pageSize': pageSize_example, // {{String}} Page size
  'pageSort': pageSort_example, // {{String}} Sorting order
  'startDate': 2013-10-20T19:20:30+01:00, // {{Date}} Start of the log entry timestamp interval to match (inclusive)
  'endDate': 2013-10-20T19:20:30+01:00, // {{Date}} End of the log entry timestamp interval to match (exclusive)
  'queryId': 2013-10-20T19:20:30+01:00 // {{Date}} Query ID for which log entries should be matched
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listChangeLogs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AuditLogsApi();
            var pageToken = pageToken_example;  // String | Page token (optional) 
            var pageSize = pageSize_example;  // String | Page size (optional)  (default to 100)
            var pageSort = pageSort_example;  // String | Sorting order (optional)  (default to desc)
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | Start of the log entry timestamp interval to match (inclusive) (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | End of the log entry timestamp interval to match (exclusive) (optional) 
            var queryId = 2013-10-20T19:20:30+01:00;  // Date | Query ID for which log entries should be matched (optional) 

            try
            {
                // List Starburst built-in access control change logs
                PaginatedResultChangeLogResponse result = apiInstance.listChangeLogs(pageToken, pageSize, pageSort, startDate, endDate, queryId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuditLogsApi.listChangeLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAuditLogsApi();
$pageToken = pageToken_example; // String | Page token
$pageSize = pageSize_example; // String | Page size
$pageSort = pageSort_example; // String | Sorting order
$startDate = 2013-10-20T19:20:30+01:00; // Date | Start of the log entry timestamp interval to match (inclusive)
$endDate = 2013-10-20T19:20:30+01:00; // Date | End of the log entry timestamp interval to match (exclusive)
$queryId = 2013-10-20T19:20:30+01:00; // Date | Query ID for which log entries should be matched

try {
    $result = $api_instance->listChangeLogs($pageToken, $pageSize, $pageSort, $startDate, $endDate, $queryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditLogsApi->listChangeLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditLogsApi;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AuditLogsApi->new();
my $pageToken = pageToken_example; # String | Page token
my $pageSize = pageSize_example; # String | Page size
my $pageSort = pageSort_example; # String | Sorting order
my $startDate = 2013-10-20T19:20:30+01:00; # Date | Start of the log entry timestamp interval to match (inclusive)
my $endDate = 2013-10-20T19:20:30+01:00; # Date | End of the log entry timestamp interval to match (exclusive)
my $queryId = 2013-10-20T19:20:30+01:00; # Date | Query ID for which log entries should be matched

eval { 
    my $result = $api_instance->listChangeLogs(pageToken => $pageToken, pageSize => $pageSize, pageSort => $pageSort, startDate => $startDate, endDate => $endDate, queryId => $queryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditLogsApi->listChangeLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AuditLogsApi()
pageToken = pageToken_example # String | Page token (optional)
pageSize = pageSize_example # String | Page size (optional) (default to 100)
pageSort = pageSort_example # String | Sorting order (optional) (default to desc)
startDate = 2013-10-20T19:20:30+01:00 # Date | Start of the log entry timestamp interval to match (inclusive) (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | End of the log entry timestamp interval to match (exclusive) (optional)
queryId = 2013-10-20T19:20:30+01:00 # Date | Query ID for which log entries should be matched (optional)

try: 
    # List Starburst built-in access control change logs
    api_response = api_instance.list_change_logs(pageToken=pageToken, pageSize=pageSize, pageSort=pageSort, startDate=startDate, endDate=endDate, queryId=queryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditLogsApi->listChangeLogs: %s\n" % e)

Parameters

Query parameters
Name Description
pageToken
String
Page token
pageSize
String
Page size
pageSort
String
Sorting order
startDate
Date (date-time)
Start of the log entry timestamp interval to match (inclusive)
endDate
Date (date-time)
End of the log entry timestamp interval to match (exclusive)
queryId
Date (date-time)
Query ID for which log entries should be matched

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden


ColumnMasks

addColumnMaskToRole

Add a column mask to a role to mask column values from subjects assigned to the role.


/api/v1/biac/roles/{roleId}/columnMasks

Usage and SDK Samples

curl -X POST\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/biac/roles/{roleId}/columnMasks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        ColumnMaskPayload body = ; // ColumnMaskPayload | 
        try {
            ColumnMaskResponse result = apiInstance.addColumnMaskToRole(roleId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#addColumnMaskToRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        ColumnMaskPayload body = ; // ColumnMaskPayload | 
        try {
            ColumnMaskResponse result = apiInstance.addColumnMaskToRole(roleId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#addColumnMaskToRole");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *roleId = 789; // 
ColumnMaskPayload *body = ; //  (optional)

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

// Add a column mask to a role to mask column values from subjects assigned to the role.
[apiInstance addColumnMaskToRoleWith:roleId
    body:body
              completionHandler: ^(ColumnMaskResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var roleId = 789;  // Long | 
            var body = new ColumnMaskPayload(); // ColumnMaskPayload |  (optional) 

            try
            {
                // Add a column mask to a role to mask column values from subjects assigned to the role.
                ColumnMaskResponse result = apiInstance.addColumnMaskToRole(roleId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.addColumnMaskToRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$roleId = 789; // Long | 
$body = ; // ColumnMaskPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $roleId = 789; # Long | 
my $body = WWW::SwaggerClient::Object::ColumnMaskPayload->new(); # ColumnMaskPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
roleId = 789 # Long | 
body =  # ColumnMaskPayload |  (optional)

try: 
    # Add a column mask to a role to mask column values from subjects assigned to the role.
    api_response = api_instance.add_column_mask_to_role(roleId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->addColumnMaskToRole: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


createColumnMaskExpression

Create an expression that can be applied to mask column values


/api/v1/biac/expressions/columnMask

Usage and SDK Samples

curl -X POST\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/biac/expressions/columnMask"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        ExpressionPayload body = ; // ExpressionPayload | 
        try {
            ExpressionResponse result = apiInstance.createColumnMaskExpression(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#createColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        ExpressionPayload body = ; // ExpressionPayload | 
        try {
            ExpressionResponse result = apiInstance.createColumnMaskExpression(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#createColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
ExpressionPayload *body = ; //  (optional)

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

// Create an expression that can be applied to mask column values
[apiInstance createColumnMaskExpressionWith:body
              completionHandler: ^(ExpressionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var body = new ExpressionPayload(); // ExpressionPayload |  (optional) 

            try
            {
                // Create an expression that can be applied to mask column values
                ExpressionResponse result = apiInstance.createColumnMaskExpression(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.createColumnMaskExpression: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$body = ; // ExpressionPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Create an expression that can be applied to mask column values
    api_response = api_instance.create_column_mask_expression(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->createColumnMaskExpression: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden


deleteColumnMaskExpression

Delete a column mask expression


/api/v1/biac/expressions/columnMask/{columnMaskExpressionId}

Usage and SDK Samples

curl -X DELETE\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/expressions/columnMask/{columnMaskExpressionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long columnMaskExpressionId = 789; // Long | 
        try {
            apiInstance.deleteColumnMaskExpression(columnMaskExpressionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#deleteColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long columnMaskExpressionId = 789; // Long | 
        try {
            apiInstance.deleteColumnMaskExpression(columnMaskExpressionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#deleteColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *columnMaskExpressionId = 789; // 

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

// Delete a column mask expression
[apiInstance deleteColumnMaskExpressionWith:columnMaskExpressionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.ColumnMasksApi()
var columnMaskExpressionId = 789; // {{Long}} 

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var columnMaskExpressionId = 789;  // Long | 

            try
            {
                // Delete a column mask expression
                apiInstance.deleteColumnMaskExpression(columnMaskExpressionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.deleteColumnMaskExpression: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$columnMaskExpressionId = 789; // Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $columnMaskExpressionId = 789; # Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
columnMaskExpressionId = 789 # Long | 

try: 
    # Delete a column mask expression
    api_instance.delete_column_mask_expression(columnMaskExpressionId)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->deleteColumnMaskExpression: %s\n" % e)

Parameters

Path parameters
Name Description
columnMaskExpressionId*
Long (int64)
Required

Responses

Status: 204 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


deleteRoleColumnMask

Remove a column mask from a role.


/api/v1/biac/roles/{roleId}/columnMasks/{columnMaskId}

Usage and SDK Samples

curl -X DELETE\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: */*,application/json"\
"//api/v1/biac/roles/{roleId}/columnMasks/{columnMaskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        Long columnMaskId = 789; // Long | 
        try {
            apiInstance.deleteRoleColumnMask(roleId, columnMaskId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#deleteRoleColumnMask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        Long columnMaskId = 789; // Long | 
        try {
            apiInstance.deleteRoleColumnMask(roleId, columnMaskId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#deleteRoleColumnMask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *roleId = 789; // 
Long *columnMaskId = 789; // 

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

// Remove a column mask from a role.
[apiInstance deleteRoleColumnMaskWith:roleId
    columnMaskId:columnMaskId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.ColumnMasksApi()
var roleId = 789; // {{Long}} 
var columnMaskId = 789; // {{Long}} 

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var roleId = 789;  // Long | 
            var columnMaskId = 789;  // Long | 

            try
            {
                // Remove a column mask from a role.
                apiInstance.deleteRoleColumnMask(roleId, columnMaskId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.deleteRoleColumnMask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$roleId = 789; // Long | 
$columnMaskId = 789; // Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $roleId = 789; # Long | 
my $columnMaskId = 789; # Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
roleId = 789 # Long | 
columnMaskId = 789 # Long | 

try: 
    # Remove a column mask from a role.
    api_instance.delete_role_column_mask(roleId, columnMaskId)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->deleteRoleColumnMask: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Long (int64)
Required
columnMaskId*
Long (int64)
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


getColumnMask

Get a column mask of a given role.


/api/v1/biac/roles/{roleId}/columnMasks/{columnMaskId}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/roles/{roleId}/columnMasks/{columnMaskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        Long columnMaskId = 789; // Long | 
        try {
            ColumnMaskResponse result = apiInstance.getColumnMask(roleId, columnMaskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#getColumnMask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        Long columnMaskId = 789; // Long | 
        try {
            ColumnMaskResponse result = apiInstance.getColumnMask(roleId, columnMaskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#getColumnMask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *roleId = 789; // 
Long *columnMaskId = 789; // 

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

// Get a column mask of a given role.
[apiInstance getColumnMaskWith:roleId
    columnMaskId:columnMaskId
              completionHandler: ^(ColumnMaskResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.ColumnMasksApi()
var roleId = 789; // {{Long}} 
var columnMaskId = 789; // {{Long}} 

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var roleId = 789;  // Long | 
            var columnMaskId = 789;  // Long | 

            try
            {
                // Get a column mask of a given role.
                ColumnMaskResponse result = apiInstance.getColumnMask(roleId, columnMaskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.getColumnMask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$roleId = 789; // Long | 
$columnMaskId = 789; // Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $roleId = 789; # Long | 
my $columnMaskId = 789; # Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
roleId = 789 # Long | 
columnMaskId = 789 # Long | 

try: 
    # Get a column mask of a given role.
    api_response = api_instance.get_column_mask(roleId, columnMaskId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->getColumnMask: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Long (int64)
Required
columnMaskId*
Long (int64)
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


getColumnMaskExpression

Get an expression that can be used to mask column values


/api/v1/biac/expressions/columnMask/{columnMaskExpressionId}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/expressions/columnMask/{columnMaskExpressionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long columnMaskExpressionId = 789; // Long | 
        try {
            ExpressionResponse result = apiInstance.getColumnMaskExpression(columnMaskExpressionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#getColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long columnMaskExpressionId = 789; // Long | 
        try {
            ExpressionResponse result = apiInstance.getColumnMaskExpression(columnMaskExpressionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#getColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *columnMaskExpressionId = 789; // 

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

// Get an expression that can be used to mask column values
[apiInstance getColumnMaskExpressionWith:columnMaskExpressionId
              completionHandler: ^(ExpressionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.ColumnMasksApi()
var columnMaskExpressionId = 789; // {{Long}} 

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var columnMaskExpressionId = 789;  // Long | 

            try
            {
                // Get an expression that can be used to mask column values
                ExpressionResponse result = apiInstance.getColumnMaskExpression(columnMaskExpressionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.getColumnMaskExpression: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$columnMaskExpressionId = 789; // Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $columnMaskExpressionId = 789; # Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
columnMaskExpressionId = 789 # Long | 

try: 
    # Get an expression that can be used to mask column values
    api_response = api_instance.get_column_mask_expression(columnMaskExpressionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->getColumnMaskExpression: %s\n" % e)

Parameters

Path parameters
Name Description
columnMaskExpressionId*
Long (int64)
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


listColumnMaskExpressions

List the expressions that can be used to mask column values


/api/v1/biac/expressions/columnMask

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/expressions/columnMask?pageToken=&pageSize=&pageSort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        try {
            PaginatedResultExpressionResponse result = apiInstance.listColumnMaskExpressions(pageToken, pageSize, pageSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#listColumnMaskExpressions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        try {
            PaginatedResultExpressionResponse result = apiInstance.listColumnMaskExpressions(pageToken, pageSize, pageSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#listColumnMaskExpressions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pageToken = pageToken_example; // Page token (optional)
String *pageSize = pageSize_example; // Page size (optional) (default to 100)
String *pageSort = pageSort_example; // Sorting order (optional) (default to desc)

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

// List the expressions that can be used to mask column values
[apiInstance listColumnMaskExpressionsWith:pageToken
    pageSize:pageSize
    pageSort:pageSort
              completionHandler: ^(PaginatedResultExpressionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.ColumnMasksApi()
var opts = { 
  'pageToken': pageToken_example, // {{String}} Page token
  'pageSize': pageSize_example, // {{String}} Page size
  'pageSort': pageSort_example // {{String}} Sorting order
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listColumnMaskExpressions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var pageToken = pageToken_example;  // String | Page token (optional) 
            var pageSize = pageSize_example;  // String | Page size (optional)  (default to 100)
            var pageSort = pageSort_example;  // String | Sorting order (optional)  (default to desc)

            try
            {
                // List the expressions that can be used to mask column values
                PaginatedResultExpressionResponse result = apiInstance.listColumnMaskExpressions(pageToken, pageSize, pageSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.listColumnMaskExpressions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$pageToken = pageToken_example; // String | Page token
$pageSize = pageSize_example; // String | Page size
$pageSort = pageSort_example; // String | Sorting order

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $pageToken = pageToken_example; # String | Page token
my $pageSize = pageSize_example; # String | Page size
my $pageSort = pageSort_example; # String | Sorting order

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
pageToken = pageToken_example # String | Page token (optional)
pageSize = pageSize_example # String | Page size (optional) (default to 100)
pageSort = pageSort_example # String | Sorting order (optional) (default to desc)

try: 
    # List the expressions that can be used to mask column values
    api_response = api_instance.list_column_mask_expressions(pageToken=pageToken, pageSize=pageSize, pageSort=pageSort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->listColumnMaskExpressions: %s\n" % e)

Parameters

Query parameters
Name Description
pageToken
String
Page token
pageSize
String
Page size
pageSort
String
Sorting order

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


listRoleColumnMasks

List all the column masks of a role.


/api/v1/biac/roles/{roleId}/columnMasks

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/roles/{roleId}/columnMasks?pageToken=&pageSize=&pageSort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        try {
            PaginatedResultColumnMaskResponse result = apiInstance.listRoleColumnMasks(roleId, pageToken, pageSize, pageSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#listRoleColumnMasks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long roleId = 789; // Long | 
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        try {
            PaginatedResultColumnMaskResponse result = apiInstance.listRoleColumnMasks(roleId, pageToken, pageSize, pageSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#listRoleColumnMasks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *roleId = 789; // 
String *pageToken = pageToken_example; // Page token (optional)
String *pageSize = pageSize_example; // Page size (optional) (default to 100)
String *pageSort = pageSort_example; // Sorting order (optional) (default to desc)

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

// List all the column masks of a role.
[apiInstance listRoleColumnMasksWith:roleId
    pageToken:pageToken
    pageSize:pageSize
    pageSort:pageSort
              completionHandler: ^(PaginatedResultColumnMaskResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.ColumnMasksApi()
var roleId = 789; // {{Long}} 
var opts = { 
  'pageToken': pageToken_example, // {{String}} Page token
  'pageSize': pageSize_example, // {{String}} Page size
  'pageSort': pageSort_example // {{String}} Sorting order
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRoleColumnMasks(roleId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var roleId = 789;  // Long | 
            var pageToken = pageToken_example;  // String | Page token (optional) 
            var pageSize = pageSize_example;  // String | Page size (optional)  (default to 100)
            var pageSort = pageSort_example;  // String | Sorting order (optional)  (default to desc)

            try
            {
                // List all the column masks of a role.
                PaginatedResultColumnMaskResponse result = apiInstance.listRoleColumnMasks(roleId, pageToken, pageSize, pageSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.listRoleColumnMasks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$roleId = 789; // Long | 
$pageToken = pageToken_example; // String | Page token
$pageSize = pageSize_example; // String | Page size
$pageSort = pageSort_example; // String | Sorting order

try {
    $result = $api_instance->listRoleColumnMasks($roleId, $pageToken, $pageSize, $pageSort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ColumnMasksApi->listRoleColumnMasks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ColumnMasksApi;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $roleId = 789; # Long | 
my $pageToken = pageToken_example; # String | Page token
my $pageSize = pageSize_example; # String | Page size
my $pageSort = pageSort_example; # String | Sorting order

eval { 
    my $result = $api_instance->listRoleColumnMasks(roleId => $roleId, pageToken => $pageToken, pageSize => $pageSize, pageSort => $pageSort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ColumnMasksApi->listRoleColumnMasks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
roleId = 789 # Long | 
pageToken = pageToken_example # String | Page token (optional)
pageSize = pageSize_example # String | Page size (optional) (default to 100)
pageSort = pageSort_example # String | Sorting order (optional) (default to desc)

try: 
    # List all the column masks of a role.
    api_response = api_instance.list_role_column_masks(roleId, pageToken=pageToken, pageSize=pageSize, pageSort=pageSort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->listRoleColumnMasks: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Long (int64)
Required
Query parameters
Name Description
pageToken
String
Page token
pageSize
String
Page size
pageSort
String
Sorting order

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


updateColumnMaskExpression

Update a column mask expression


/api/v1/biac/expressions/columnMask/{columnMaskExpressionId}

Usage and SDK Samples

curl -X PUT\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/biac/expressions/columnMask/{columnMaskExpressionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ColumnMasksApi;

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

public class ColumnMasksApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long columnMaskExpressionId = 789; // Long | 
        ExpressionPayload body = ; // ExpressionPayload | 
        try {
            ExpressionResponse result = apiInstance.updateColumnMaskExpression(columnMaskExpressionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#updateColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ColumnMasksApi;

public class ColumnMasksApiExample {

    public static void main(String[] args) {
        ColumnMasksApi apiInstance = new ColumnMasksApi();
        Long columnMaskExpressionId = 789; // Long | 
        ExpressionPayload body = ; // ExpressionPayload | 
        try {
            ExpressionResponse result = apiInstance.updateColumnMaskExpression(columnMaskExpressionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ColumnMasksApi#updateColumnMaskExpression");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *columnMaskExpressionId = 789; // 
ExpressionPayload *body = ; //  (optional)

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

// Update a column mask expression
[apiInstance updateColumnMaskExpressionWith:columnMaskExpressionId
    body:body
              completionHandler: ^(ExpressionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ColumnMasksApi();
            var columnMaskExpressionId = 789;  // Long | 
            var body = new ExpressionPayload(); // ExpressionPayload |  (optional) 

            try
            {
                // Update a column mask expression
                ExpressionResponse result = apiInstance.updateColumnMaskExpression(columnMaskExpressionId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ColumnMasksApi.updateColumnMaskExpression: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiColumnMasksApi();
$columnMaskExpressionId = 789; // Long | 
$body = ; // ExpressionPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ColumnMasksApi->new();
my $columnMaskExpressionId = 789; # Long | 
my $body = WWW::SwaggerClient::Object::ExpressionPayload->new(); # ExpressionPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ColumnMasksApi()
columnMaskExpressionId = 789 # Long | 
body =  # ExpressionPayload |  (optional)

try: 
    # Update a column mask expression
    api_response = api_instance.update_column_mask_expression(columnMaskExpressionId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ColumnMasksApi->updateColumnMaskExpression: %s\n" % e)

Parameters

Path parameters
Name Description
columnMaskExpressionId*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 Accept header of 'application/yaml' to request a YAML response instead of JSON.


/api/v1/dataProduct/openApi

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Return the OpenAPI specification for the Data Product API.  Use Accept header 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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DataProductsApi();

            try
            {
                // Return the OpenAPI specification for the Data Product API.  Use Accept header 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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Return the OpenAPI specification for the Data Product API.  Use Accept header 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        DataProductsApi apiInstance = new DataProductsApi();
        try {
            array[CatalogDetails] 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[CatalogDetails] result = apiInstance.getTargetCatalogs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#getTargetCatalogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

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

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DataProductsApi();

            try
            {
                // Return all catalogs suitable to store data products
                array[CatalogDetails] 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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        DataProductsApi apiInstance = new DataProductsApi();
        SearchOptions body = ; // SearchOptions | 
        SearchOptionsParam searchOptions = ; // SearchOptionsParam | An URL-encoded JSON value - see the body parameter for description of the schema
        try {
            array[Data product summary] result = apiInstance.searchDataProducts(body, 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();
        SearchOptions body = ; // SearchOptions | 
        SearchOptionsParam searchOptions = ; // SearchOptionsParam | An URL-encoded JSON value - see the body parameter for description of the schema
        try {
            array[Data product summary] result = apiInstance.searchDataProducts(body, searchOptions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#searchDataProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
SearchOptions *body = ; //  (optional)
SearchOptionsParam *searchOptions = ; // An URL-encoded JSON value - see the body parameter for description of the schema (optional)

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

// Search for data products according to the searchOptions request parameter.
[apiInstance searchDataProductsWith:body
    searchOptions: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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.DataProductsApi()
var opts = { 
  'body':  // {{SearchOptions}} 
  'searchOptions':  // {{SearchOptionsParam}} An URL-encoded JSON value - see the body parameter for description of the schema
};
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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DataProductsApi();
            var body = new SearchOptions(); // SearchOptions |  (optional) 
            var searchOptions = new SearchOptionsParam(); // SearchOptionsParam | An URL-encoded JSON value - see the body parameter for description of the schema (optional) 

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

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDataProductsApi();
$body = ; // SearchOptions | 
$searchOptions = ; // SearchOptionsParam | An URL-encoded JSON value - see the body parameter for description of the schema

try {
    $result = $api_instance->searchDataProducts($body, $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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DataProductsApi->new();
my $body = WWW::SwaggerClient::Object::SearchOptions->new(); # SearchOptions | 
my $searchOptions = ; # SearchOptionsParam | An URL-encoded JSON value - see the body parameter for description of the schema

eval { 
    my $result = $api_instance->searchDataProducts(body => $body, 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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DataProductsApi()
body =  # SearchOptions |  (optional)
searchOptions =  # SearchOptionsParam | An URL-encoded JSON value - see the body parameter for description of the schema (optional)

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

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
searchOptions
SearchOptionsParam
An URL-encoded JSON value - see the body parameter for description of the schema

Responses

Status: 200 - Success


updateDataProduct

Update a data product


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

Usage and SDK Samples

curl -X PUT\
\
 -H "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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


updateMaterializedViewInDataProduct

Create/Update a materialized view in data product


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

Usage and SDK Samples

curl -X PUT\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/materializedViews"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        MaterializedViewDatasetPayload body = ; // MaterializedViewDatasetPayload | 
        try {
            Data product result = apiInstance.updateMaterializedViewInDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateMaterializedViewInDataProduct");
            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 | 
        MaterializedViewDatasetPayload body = ; // MaterializedViewDatasetPayload | 
        try {
            Data product result = apiInstance.updateMaterializedViewInDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateMaterializedViewInDataProduct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
MaterializedViewDatasetPayload *body = ; //  (optional)

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

// Create/Update a materialized view in data product
[apiInstance updateMaterializedViewInDataProductWith: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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

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

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

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Create/Update a materialized view in data product
    api_response = api_instance.update_materialized_view_in_data_product(dataProductId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->updateMaterializedViewInDataProduct: %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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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


updateViewInDataProduct

Create/Updates a view in a DataProducts


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

Usage and SDK Samples

curl -X PUT\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/dataProduct/products/{dataProductId}/views"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        DataProductsApi apiInstance = new DataProductsApi();
        UUID dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ViewDatasetPayload body = ; // ViewDatasetPayload | 
        try {
            Data product result = apiInstance.updateViewInDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateViewInDataProduct");
            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 | 
        ViewDatasetPayload body = ; // ViewDatasetPayload | 
        try {
            Data product result = apiInstance.updateViewInDataProduct(dataProductId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataProductsApi#updateViewInDataProduct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
UUID *dataProductId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
ViewDatasetPayload *body = ; //  (optional)

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

// Create/Updates a view in a DataProducts
[apiInstance updateViewInDataProductWith: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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

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

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

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Create/Updates a view in a DataProducts
    api_response = api_instance.update_view_in_data_product(dataProductId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataProductsApi->updateViewInDataProduct: %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


Domains

createDomain

Create a data product domain


/api/v1/dataProduct/domains

Usage and SDK Samples

curl -X POST\
\
 -H "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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 "Authorization: Basic [[basicHash]]"\
-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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        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();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
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 defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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()
        {

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            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');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$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;

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# 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


EntityCategories

listAvailableActions

List all actions that can be allowed or denied for an EntityCategory


/api/v1/biac/entityCategories/{entityCategory}/actions

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/entityCategories/{entityCategory}/actions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntityCategoriesApi;

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

public class EntityCategoriesApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        EntityCategoriesApi apiInstance = new EntityCategoriesApi();
        String entityCategory = entityCategory_example; // String | 
        try {
            PaginatedResultAction result = apiInstance.listAvailableActions(entityCategory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityCategoriesApi#listAvailableActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntityCategoriesApi;

public class EntityCategoriesApiExample {

    public static void main(String[] args) {
        EntityCategoriesApi apiInstance = new EntityCategoriesApi();
        String entityCategory = entityCategory_example; // String | 
        try {
            PaginatedResultAction result = apiInstance.listAvailableActions(entityCategory);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityCategoriesApi#listAvailableActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *entityCategory = entityCategory_example; // 

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

// List all actions that can be allowed or denied for an EntityCategory
[apiInstance listAvailableActionsWith:entityCategory
              completionHandler: ^(PaginatedResultAction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.EntityCategoriesApi()
var entityCategory = entityCategory_example; // {{String}} 

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new EntityCategoriesApi();
            var entityCategory = entityCategory_example;  // String | 

            try
            {
                // List all actions that can be allowed or denied for an EntityCategory
                PaginatedResultAction result = apiInstance.listAvailableActions(entityCategory);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntityCategoriesApi.listAvailableActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiEntityCategoriesApi();
$entityCategory = entityCategory_example; // String | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::EntityCategoriesApi->new();
my $entityCategory = entityCategory_example; # String | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EntityCategoriesApi()
entityCategory = entityCategory_example # String | 

try: 
    # List all actions that can be allowed or denied for an EntityCategory
    api_response = api_instance.list_available_actions(entityCategory)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityCategoriesApi->listAvailableActions: %s\n" % e)

Parameters

Path parameters
Name Description
entityCategory*
String
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized


listEntityCategories

List all entity categories in which access control can be managed by Starburst built-in access control.


/api/v1/biac/entityCategories

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/entityCategories?pageToken=&pageSize=&pageSort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntityCategoriesApi;

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

public class EntityCategoriesApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        EntityCategoriesApi apiInstance = new EntityCategoriesApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        try {
            PaginatedResultEntityCategory result = apiInstance.listEntityCategories(pageToken, pageSize, pageSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityCategoriesApi#listEntityCategories");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntityCategoriesApi;

public class EntityCategoriesApiExample {

    public static void main(String[] args) {
        EntityCategoriesApi apiInstance = new EntityCategoriesApi();
        String pageToken = pageToken_example; // String | Page token
        String pageSize = pageSize_example; // String | Page size
        String pageSort = pageSort_example; // String | Sorting order
        try {
            PaginatedResultEntityCategory result = apiInstance.listEntityCategories(pageToken, pageSize, pageSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityCategoriesApi#listEntityCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pageToken = pageToken_example; // Page token (optional)
String *pageSize = pageSize_example; // Page size (optional) (default to 100)
String *pageSort = pageSort_example; // Sorting order (optional) (default to desc)

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

// List all entity categories in which access control can be managed by Starburst built-in access control.
[apiInstance listEntityCategoriesWith:pageToken
    pageSize:pageSize
    pageSort:pageSort
              completionHandler: ^(PaginatedResultEntityCategory output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.EntityCategoriesApi()
var opts = { 
  'pageToken': pageToken_example, // {{String}} Page token
  'pageSize': pageSize_example, // {{String}} Page size
  'pageSort': pageSort_example // {{String}} Sorting order
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listEntityCategories(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new EntityCategoriesApi();
            var pageToken = pageToken_example;  // String | Page token (optional) 
            var pageSize = pageSize_example;  // String | Page size (optional)  (default to 100)
            var pageSort = pageSort_example;  // String | Sorting order (optional)  (default to desc)

            try
            {
                // List all entity categories in which access control can be managed by Starburst built-in access control.
                PaginatedResultEntityCategory result = apiInstance.listEntityCategories(pageToken, pageSize, pageSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntityCategoriesApi.listEntityCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiEntityCategoriesApi();
$pageToken = pageToken_example; // String | Page token
$pageSize = pageSize_example; // String | Page size
$pageSort = pageSort_example; // String | Sorting order

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::EntityCategoriesApi->new();
my $pageToken = pageToken_example; # String | Page token
my $pageSize = pageSize_example; # String | Page size
my $pageSort = pageSort_example; # String | Sorting order

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EntityCategoriesApi()
pageToken = pageToken_example # String | Page token (optional)
pageSize = pageSize_example # String | Page size (optional) (default to 100)
pageSort = pageSort_example # String | Sorting order (optional) (default to desc)

try: 
    # List all entity categories in which access control can be managed by Starburst built-in access control.
    api_response = api_instance.list_entity_categories(pageToken=pageToken, pageSize=pageSize, pageSort=pageSort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityCategoriesApi->listEntityCategories: %s\n" % e)

Parameters

Query parameters
Name Description
pageToken
String
Page token
pageSize
String
Page size
pageSort
String
Sorting order

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Grants

createGrant

Create a Starburst built-in access control grant for a role


/api/v1/biac/roles/{roleId}/grants

Usage and SDK Samples

curl -X POST\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v1/biac/roles/{roleId}/grants"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GrantsApi;

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

public class GrantsApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        GrantsApi apiInstance = new GrantsApi();
        Long roleId = 789; // Long | 
        CreateGrantPayload body = ; // CreateGrantPayload | 
        try {
            GrantResponse result = apiInstance.createGrant(roleId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrantsApi#createGrant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GrantsApi;

public class GrantsApiExample {

    public static void main(String[] args) {
        GrantsApi apiInstance = new GrantsApi();
        Long roleId = 789; // Long | 
        CreateGrantPayload body = ; // CreateGrantPayload | 
        try {
            GrantResponse result = apiInstance.createGrant(roleId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrantsApi#createGrant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *roleId = 789; // 
CreateGrantPayload *body = ; //  (optional)

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

// Create a Starburst built-in access control grant for a role
[apiInstance createGrantWith:roleId
    body:body
              completionHandler: ^(GrantResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GrantsApi();
            var roleId = 789;  // Long | 
            var body = new CreateGrantPayload(); // CreateGrantPayload |  (optional) 

            try
            {
                // Create a Starburst built-in access control grant for a role
                GrantResponse result = apiInstance.createGrant(roleId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GrantsApi.createGrant: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGrantsApi();
$roleId = 789; // Long | 
$body = ; // CreateGrantPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GrantsApi->new();
my $roleId = 789; # Long | 
my $body = WWW::SwaggerClient::Object::CreateGrantPayload->new(); # CreateGrantPayload | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GrantsApi()
roleId = 789 # Long | 
body =  # CreateGrantPayload |  (optional)

try: 
    # Create a Starburst built-in access control grant for a role
    api_response = api_instance.create_grant(roleId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GrantsApi->createGrant: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 409 - Conflict


deleteGrant

Delete a Starburst built-in access control grant of a role


/api/v1/biac/roles/{roleId}/grants/{grantId}

Usage and SDK Samples

curl -X DELETE\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: */*,application/json"\
"//api/v1/biac/roles/{roleId}/grants/{grantId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GrantsApi;

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

public class GrantsApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        GrantsApi apiInstance = new GrantsApi();
        Long roleId = 789; // Long | 
        Long grantId = 789; // Long | 
        try {
            apiInstance.deleteGrant(roleId, grantId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrantsApi#deleteGrant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GrantsApi;

public class GrantsApiExample {

    public static void main(String[] args) {
        GrantsApi apiInstance = new GrantsApi();
        Long roleId = 789; // Long | 
        Long grantId = 789; // Long | 
        try {
            apiInstance.deleteGrant(roleId, grantId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrantsApi#deleteGrant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: 01_Cf_Access_OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure HTTP basic authorization (authentication scheme: 02_Cf_Access_Basic)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Long *roleId = 789; // 
Long *grantId = 789; // 

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

// Delete a Starburst built-in access control grant of a role
[apiInstance deleteGrantWith:roleId
    grantId:grantId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StarburstEnterpriseApiDocumentation = require('starburst_enterprise_api_documentation');
var defaultClient = StarburstEnterpriseApiDocumentation.ApiClient.instance;

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
var 01_Cf_Access_OAuth2 = defaultClient.authentications['01_Cf_Access_OAuth2'];
01_Cf_Access_OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure HTTP basic authorization: 02_Cf_Access_Basic
var 02_Cf_Access_Basic = defaultClient.authentications['02_Cf_Access_Basic'];
02_Cf_Access_Basic.username = 'YOUR USERNAME'
02_Cf_Access_Basic.password = 'YOUR PASSWORD'

var api = new StarburstEnterpriseApiDocumentation.GrantsApi()
var roleId = 789; // {{Long}} 
var grantId = 789; // {{Long}} 

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

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

            // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";            // Configure HTTP basic authorization: 02_Cf_Access_Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GrantsApi();
            var roleId = 789;  // Long | 
            var grantId = 789;  // Long | 

            try
            {
                // Delete a Starburst built-in access control grant of a role
                apiInstance.deleteGrant(roleId, grantId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GrantsApi.deleteGrant: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');// Configure HTTP basic authorization: 02_Cf_Access_Basic
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGrantsApi();
$roleId = 789; // Long | 
$grantId = 789; // Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';# Configure HTTP basic authorization: 02_Cf_Access_Basic
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GrantsApi->new();
my $roleId = 789; # Long | 
my $grantId = 789; # Long | 

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

# Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'# Configure HTTP basic authorization: 02_Cf_Access_Basic
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GrantsApi()
roleId = 789 # Long | 
grantId = 789 # Long | 

try: 
    # Delete a Starburst built-in access control grant of a role
    api_instance.delete_grant(roleId, grantId)
except ApiException as e:
    print("Exception when calling GrantsApi->deleteGrant: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Long (int64)
Required
grantId*
Long (int64)
Required

Responses

Status: 204 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


getGrant

Get a Starburst built-in access control grant of a role


/api/v1/biac/roles/{roleId}/grants/{grantId}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"//api/v1/biac/roles/{roleId}/grants/{grantId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GrantsApi;

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

public class GrantsApiExample {

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

        // Configure OAuth2 access token for authorization: 01_Cf_Access_OAuth2
        OAuth 01_Cf_Access_OAuth2 = (OAuth) defaultClient.getAuthentication("01_Cf_Access_OAuth2");
        01_Cf_Access_OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        // Configure HTTP basic authorization: 02_Cf_Access_Basic
        HttpBasicAuth 02_Cf_Access_Basic = (HttpBasicAuth) defaultClient.getAuthentication("02_Cf_Access_Basic");
        02_Cf_Access_Basic.setUsername("YOUR USERNAME");
        02_Cf_Access_Basic.setPassword("YOUR PASSWORD");

        GrantsApi apiInstance = new GrantsApi();
        Long roleId = 789; // Long | 
        Long grantId = 789; // Long | 
        try {
            GrantResponse result = apiInstance.getGrant(roleId, grantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrantsApi#getGrant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GrantsApi;

public class GrantsApiExample {

    public static void main(String[] args) {
        GrantsApi apiInstance = new GrantsApi();
        Long roleId = 789; // Long | 
        Long grantId = 789; // Long | 
        try {
            GrantResponse result = apiInstance.getGrant(roleId, grantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrantsApi#getGrant");
            e.printStackTrace();
        }
    }
}