Data Hub

Default

dELETEDataFeedsFeedNameTypesItemType

Deletes canonical items by type


/data-feeds/{feedName}/types/{itemType}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds/{feedName}/types/{itemType}?rawFields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of raw items created through the data feed that will be operated on
        String feedName = feedName_example; // String | Name of the data feed
        String rawFields = rawFields_example; // String | JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.
        try {
            result result = apiInstance.dELETEDataFeedsFeedNameTypesItemType(itemType, feedName, rawFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#dELETEDataFeedsFeedNameTypesItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of raw items created through the data feed that will be operated on
        String feedName = feedName_example; // String | Name of the data feed
        String rawFields = rawFields_example; // String | JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.
        try {
            result result = apiInstance.dELETEDataFeedsFeedNameTypesItemType(itemType, feedName, rawFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#dELETEDataFeedsFeedNameTypesItemType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // The type of raw items created through the data feed that will be operated on
String *feedName = feedName_example; // Name of the data feed
String *rawFields = rawFields_example; // JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.

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

[apiInstance dELETEDataFeedsFeedNameTypesItemTypeWith:itemType
    feedName:feedName
    rawFields:rawFields
              completionHandler: ^(result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} The type of raw items created through the data feed that will be operated on
var feedName = feedName_example; // {{String}} Name of the data feed
var rawFields = rawFields_example; // {{String}} JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.

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

namespace Example
{
    public class dELETEDataFeedsFeedNameTypesItemTypeExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | The type of raw items created through the data feed that will be operated on
            var feedName = feedName_example;  // String | Name of the data feed
            var rawFields = rawFields_example;  // String | JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.

            try
            {
                result result = apiInstance.dELETEDataFeedsFeedNameTypesItemType(itemType, feedName, rawFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.dELETEDataFeedsFeedNameTypesItemType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | The type of raw items created through the data feed that will be operated on
$feedName = feedName_example; // String | Name of the data feed
$rawFields = rawFields_example; // String | JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.

try {
    $result = $api_instance->dELETEDataFeedsFeedNameTypesItemType($itemType, $feedName, $rawFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->dELETEDataFeedsFeedNameTypesItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | The type of raw items created through the data feed that will be operated on
my $feedName = feedName_example; # String | Name of the data feed
my $rawFields = rawFields_example; # String | JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.

eval { 
    my $result = $api_instance->dELETEDataFeedsFeedNameTypesItemType(itemType => $itemType, feedName => $feedName, rawFields => $rawFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->dELETEDataFeedsFeedNameTypesItemType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | The type of raw items created through the data feed that will be operated on
feedName = feedName_example # String | Name of the data feed
rawFields = rawFields_example # String | JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.

try: 
    api_response = api_instance.d_elete_data_feeds_feed_name_types_item_type(itemType, feedName, rawFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->dELETEDataFeedsFeedNameTypesItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
The type of raw items created through the data feed that will be operated on
Required
feedName*
String
Name of the data feed
Required
Query parameters
Name Description
rawFields*
String
JSON formatted object of the names and values used to identify the raw item. This raw item is the source that the deleted items originated from.
Required

Responses

Status: 200 -


dELETEPoolsPoolNameItemsItemType

Deletes canonical items by type


/pools/{poolName}/items/{itemType}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/items/{itemType}?keyFields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        String poolName = poolName_example; // String | Name of the pool
        String keyFields = keyFields_example; // String | JSON formatted object of the names and values that identify the key fields of the specified canonical item
        try {
            result result = apiInstance.dELETEPoolsPoolNameItemsItemType(itemType, poolName, keyFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#dELETEPoolsPoolNameItemsItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        String poolName = poolName_example; // String | Name of the pool
        String keyFields = keyFields_example; // String | JSON formatted object of the names and values that identify the key fields of the specified canonical item
        try {
            result result = apiInstance.dELETEPoolsPoolNameItemsItemType(itemType, poolName, keyFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#dELETEPoolsPoolNameItemsItemType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // The type of item to be returned
String *poolName = poolName_example; // Name of the pool
String *keyFields = keyFields_example; // JSON formatted object of the names and values that identify the key fields of the specified canonical item

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

[apiInstance dELETEPoolsPoolNameItemsItemTypeWith:itemType
    poolName:poolName
    keyFields:keyFields
              completionHandler: ^(result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} The type of item to be returned
var poolName = poolName_example; // {{String}} Name of the pool
var keyFields = keyFields_example; // {{String}} JSON formatted object of the names and values that identify the key fields of the specified canonical item

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

namespace Example
{
    public class dELETEPoolsPoolNameItemsItemTypeExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | The type of item to be returned
            var poolName = poolName_example;  // String | Name of the pool
            var keyFields = keyFields_example;  // String | JSON formatted object of the names and values that identify the key fields of the specified canonical item

            try
            {
                result result = apiInstance.dELETEPoolsPoolNameItemsItemType(itemType, poolName, keyFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.dELETEPoolsPoolNameItemsItemType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | The type of item to be returned
$poolName = poolName_example; // String | Name of the pool
$keyFields = keyFields_example; // String | JSON formatted object of the names and values that identify the key fields of the specified canonical item

try {
    $result = $api_instance->dELETEPoolsPoolNameItemsItemType($itemType, $poolName, $keyFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->dELETEPoolsPoolNameItemsItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | The type of item to be returned
my $poolName = poolName_example; # String | Name of the pool
my $keyFields = keyFields_example; # String | JSON formatted object of the names and values that identify the key fields of the specified canonical item

eval { 
    my $result = $api_instance->dELETEPoolsPoolNameItemsItemType(itemType => $itemType, poolName => $poolName, keyFields => $keyFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->dELETEPoolsPoolNameItemsItemType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | The type of item to be returned
poolName = poolName_example # String | Name of the pool
keyFields = keyFields_example # String | JSON formatted object of the names and values that identify the key fields of the specified canonical item

try: 
    api_response = api_instance.d_elete_pools_pool_name_items_item_type(itemType, poolName, keyFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->dELETEPoolsPoolNameItemsItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
The type of item to be returned
Required
poolName*
String
Name of the pool
Required
Query parameters
Name Description
keyFields*
String
JSON formatted object of the names and values that identify the key fields of the specified canonical item
Required

Responses

Status: 200 -


gETCanonicalItemsItemId

Returns canonical item by item id


/canonical-items/{itemId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/canonical-items/{itemId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer itemId = 56; // Integer | ID of the canonical item
        try {
            data-item result = apiInstance.gETCanonicalItemsItemId(itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCanonicalItemsItemId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer itemId = 56; // Integer | ID of the canonical item
        try {
            data-item result = apiInstance.gETCanonicalItemsItemId(itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCanonicalItemsItemId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *itemId = 56; // ID of the canonical item

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

[apiInstance gETCanonicalItemsItemIdWith:itemId
              completionHandler: ^(data-item output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemId = 56; // {{Integer}} ID of the canonical item

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

namespace Example
{
    public class gETCanonicalItemsItemIdExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemId = 56;  // Integer | ID of the canonical item

            try
            {
                data-item result = apiInstance.gETCanonicalItemsItemId(itemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETCanonicalItemsItemId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemId = 56; // Integer | ID of the canonical item

try {
    $result = $api_instance->gETCanonicalItemsItemId($itemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETCanonicalItemsItemId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemId = 56; # Integer | ID of the canonical item

eval { 
    my $result = $api_instance->gETCanonicalItemsItemId(itemId => $itemId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETCanonicalItemsItemId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemId = 56 # Integer | ID of the canonical item

try: 
    api_response = api_instance.g_et_canonical_items_item_id(itemId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETCanonicalItemsItemId: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Integer
ID of the canonical item
Required

Responses

Status: 200 -


gETCompositions

Returns all compositions


/compositions

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/compositions?q=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
        Integer pageNumber = 56; // Integer | The page number of the returned compositions.
        Integer pageSize = 56; // Integer | The size of a returned page of compositions.
        try {
            compositions result = apiInstance.gETCompositions(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCompositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
        Integer pageNumber = 56; // Integer | The page number of the returned compositions.
        Integer pageSize = 56; // Integer | The size of a returned page of compositions.
        try {
            compositions result = apiInstance.gETCompositions(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCompositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *q = q_example; // Query string in lucene syntax.  Supported terms are 'status' (0-many)
Integer *pageNumber = 56; // The page number of the returned compositions. (default to 0)
Integer *pageSize = 56; // The size of a returned page of compositions. (default to 50)

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

[apiInstance gETCompositionsWith:q
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(compositions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var q = q_example; // {{String}} Query string in lucene syntax.  Supported terms are 'status' (0-many)
var pageNumber = 56; // {{Integer}} The page number of the returned compositions.
var pageSize = 56; // {{Integer}} The size of a returned page of compositions.

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

namespace Example
{
    public class gETCompositionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var q = q_example;  // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
            var pageNumber = 56;  // Integer | The page number of the returned compositions. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of compositions. (default to 50)

            try
            {
                compositions result = apiInstance.gETCompositions(q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETCompositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
$pageNumber = 56; // Integer | The page number of the returned compositions.
$pageSize = 56; // Integer | The size of a returned page of compositions.

try {
    $result = $api_instance->gETCompositions($q, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETCompositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $q = q_example; # String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
my $pageNumber = 56; # Integer | The page number of the returned compositions.
my $pageSize = 56; # Integer | The size of a returned page of compositions.

eval { 
    my $result = $api_instance->gETCompositions(q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETCompositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
q = q_example # String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
pageNumber = 56 # Integer | The page number of the returned compositions. (default to 0)
pageSize = 56 # Integer | The size of a returned page of compositions. (default to 50)

try: 
    api_response = api_instance.g_et_compositions(q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETCompositions: %s\n" % e)

Parameters

Query parameters
Name Description
q*
String
Query string in lucene syntax. Supported terms are 'status' (0-many)
Required
pageNumber*
Integer
The page number of the returned compositions.
Required
pageSize*
Integer
The size of a returned page of compositions.
Required

Responses

Status: 200 -


gETCompositionsCompositionId


/compositions/{compositionId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/compositions/{compositionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer compositionId = 56; // Integer | ID of the composition action
        try {
            composition result = apiInstance.gETCompositionsCompositionId(compositionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCompositionsCompositionId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer compositionId = 56; // Integer | ID of the composition action
        try {
            composition result = apiInstance.gETCompositionsCompositionId(compositionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCompositionsCompositionId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *compositionId = 56; // ID of the composition action

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

[apiInstance gETCompositionsCompositionIdWith:compositionId
              completionHandler: ^(composition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var compositionId = 56; // {{Integer}} ID of the composition action

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

namespace Example
{
    public class gETCompositionsCompositionIdExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var compositionId = 56;  // Integer | ID of the composition action

            try
            {
                composition result = apiInstance.gETCompositionsCompositionId(compositionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETCompositionsCompositionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$compositionId = 56; // Integer | ID of the composition action

try {
    $result = $api_instance->gETCompositionsCompositionId($compositionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETCompositionsCompositionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $compositionId = 56; # Integer | ID of the composition action

eval { 
    my $result = $api_instance->gETCompositionsCompositionId(compositionId => $compositionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETCompositionsCompositionId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
compositionId = 56 # Integer | ID of the composition action

try: 
    api_response = api_instance.g_et_compositions_composition_id(compositionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETCompositionsCompositionId: %s\n" % e)

Parameters

Path parameters
Name Description
compositionId*
Integer
ID of the composition action
Required

Responses

Status: 200 -


gETCompositionsCompositionIdErrors

Returns errors by composition action ID


/compositions/{compositionId}/errors

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/compositions/{compositionId}/errors?pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer compositionId = 56; // Integer | ID of the composition action
        Integer pageNumber = 56; // Integer | The page number of the returned errors.
        Integer pageSize = 56; // Integer | The size of a returned page of errors.
        try {
            errors result = apiInstance.gETCompositionsCompositionIdErrors(compositionId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCompositionsCompositionIdErrors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer compositionId = 56; // Integer | ID of the composition action
        Integer pageNumber = 56; // Integer | The page number of the returned errors.
        Integer pageSize = 56; // Integer | The size of a returned page of errors.
        try {
            errors result = apiInstance.gETCompositionsCompositionIdErrors(compositionId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETCompositionsCompositionIdErrors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *compositionId = 56; // ID of the composition action
Integer *pageNumber = 56; // The page number of the returned errors. (default to 0)
Integer *pageSize = 56; // The size of a returned page of errors. (default to 50)

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

[apiInstance gETCompositionsCompositionIdErrorsWith:compositionId
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(errors output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var compositionId = 56; // {{Integer}} ID of the composition action
var pageNumber = 56; // {{Integer}} The page number of the returned errors.
var pageSize = 56; // {{Integer}} The size of a returned page of errors.

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

namespace Example
{
    public class gETCompositionsCompositionIdErrorsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var compositionId = 56;  // Integer | ID of the composition action
            var pageNumber = 56;  // Integer | The page number of the returned errors. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of errors. (default to 50)

            try
            {
                errors result = apiInstance.gETCompositionsCompositionIdErrors(compositionId, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETCompositionsCompositionIdErrors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$compositionId = 56; // Integer | ID of the composition action
$pageNumber = 56; // Integer | The page number of the returned errors.
$pageSize = 56; // Integer | The size of a returned page of errors.

try {
    $result = $api_instance->gETCompositionsCompositionIdErrors($compositionId, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETCompositionsCompositionIdErrors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $compositionId = 56; # Integer | ID of the composition action
my $pageNumber = 56; # Integer | The page number of the returned errors.
my $pageSize = 56; # Integer | The size of a returned page of errors.

eval { 
    my $result = $api_instance->gETCompositionsCompositionIdErrors(compositionId => $compositionId, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETCompositionsCompositionIdErrors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
compositionId = 56 # Integer | ID of the composition action
pageNumber = 56 # Integer | The page number of the returned errors. (default to 0)
pageSize = 56 # Integer | The size of a returned page of errors. (default to 50)

try: 
    api_response = api_instance.g_et_compositions_composition_id_errors(compositionId, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETCompositionsCompositionIdErrors: %s\n" % e)

Parameters

Path parameters
Name Description
compositionId*
Integer
ID of the composition action
Required
Query parameters
Name Description
pageNumber*
Integer
The page number of the returned errors.
Required
pageSize*
Integer
The size of a returned page of errors.
Required

Responses

Status: 200 -


gETDataFeeds

Returns all data feeds that have been created in the Data Hub


/data-feeds

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            data-feeds result = apiInstance.gETDataFeeds();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeeds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            data-feeds result = apiInstance.gETDataFeeds();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETDataFeedsWithCompletionHandler: 
              ^(data-feeds output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETDataFeedsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                data-feeds result = apiInstance.gETDataFeeds();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETDataFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETDataFeeds();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETDataFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETDataFeeds();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETDataFeeds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_data_feeds()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETDataFeeds: %s\n" % e)

Parameters

Responses

Status: 200 -


gETDataFeedsDataLoads

Returns all data loading actions for a data feed


/data-feeds/data-loads

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds/data-loads?q=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
        Integer pageNumber = 56; // Integer | The page number of the returned data-loads.
        Integer pageSize = 56; // Integer | The size of a returned page of data-loads.
        try {
            data-loads result = apiInstance.gETDataFeedsDataLoads(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeedsDataLoads");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
        Integer pageNumber = 56; // Integer | The page number of the returned data-loads.
        Integer pageSize = 56; // Integer | The size of a returned page of data-loads.
        try {
            data-loads result = apiInstance.gETDataFeedsDataLoads(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeedsDataLoads");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *q = q_example; // Query string in lucene syntax.  Supported term is 'status' (0-many)
Integer *pageNumber = 56; // The page number of the returned data-loads. (default to 0)
Integer *pageSize = 56; // The size of a returned page of data-loads. (default to 50)

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

[apiInstance gETDataFeedsDataLoadsWith:q
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(data-loads output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var q = q_example; // {{String}} Query string in lucene syntax.  Supported term is 'status' (0-many)
var pageNumber = 56; // {{Integer}} The page number of the returned data-loads.
var pageSize = 56; // {{Integer}} The size of a returned page of data-loads.

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

namespace Example
{
    public class gETDataFeedsDataLoadsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var q = q_example;  // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
            var pageNumber = 56;  // Integer | The page number of the returned data-loads. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of data-loads. (default to 50)

            try
            {
                data-loads result = apiInstance.gETDataFeedsDataLoads(q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETDataFeedsDataLoads: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$q = q_example; // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
$pageNumber = 56; // Integer | The page number of the returned data-loads.
$pageSize = 56; // Integer | The size of a returned page of data-loads.

try {
    $result = $api_instance->gETDataFeedsDataLoads($q, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETDataFeedsDataLoads: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $q = q_example; # String | Query string in lucene syntax.  Supported term is 'status' (0-many)
my $pageNumber = 56; # Integer | The page number of the returned data-loads.
my $pageSize = 56; # Integer | The size of a returned page of data-loads.

eval { 
    my $result = $api_instance->gETDataFeedsDataLoads(q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETDataFeedsDataLoads: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
q = q_example # String | Query string in lucene syntax.  Supported term is 'status' (0-many)
pageNumber = 56 # Integer | The page number of the returned data-loads. (default to 0)
pageSize = 56 # Integer | The size of a returned page of data-loads. (default to 50)

try: 
    api_response = api_instance.g_et_data_feeds_data_loads(q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETDataFeedsDataLoads: %s\n" % e)

Parameters

Query parameters
Name Description
q*
String
Query string in lucene syntax. Supported term is 'status' (0-many)
Required
pageNumber*
Integer
The page number of the returned data-loads.
Required
pageSize*
Integer
The size of a returned page of data-loads.
Required

Responses

Status: 200 -


gETDataFeedsFeedName

Returns data feed information


/data-feeds/{feedName}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds/{feedName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String feedName = feedName_example; // String | Name of the data feed
        try {
            data-feed result = apiInstance.gETDataFeedsFeedName(feedName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeedsFeedName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String feedName = feedName_example; // String | Name of the data feed
        try {
            data-feed result = apiInstance.gETDataFeedsFeedName(feedName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeedsFeedName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *feedName = feedName_example; // Name of the data feed

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

[apiInstance gETDataFeedsFeedNameWith:feedName
              completionHandler: ^(data-feed output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var feedName = feedName_example; // {{String}} Name of the data feed

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

namespace Example
{
    public class gETDataFeedsFeedNameExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var feedName = feedName_example;  // String | Name of the data feed

            try
            {
                data-feed result = apiInstance.gETDataFeedsFeedName(feedName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETDataFeedsFeedName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$feedName = feedName_example; // String | Name of the data feed

try {
    $result = $api_instance->gETDataFeedsFeedName($feedName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETDataFeedsFeedName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $feedName = feedName_example; # String | Name of the data feed

eval { 
    my $result = $api_instance->gETDataFeedsFeedName(feedName => $feedName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETDataFeedsFeedName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
feedName = feedName_example # String | Name of the data feed

try: 
    api_response = api_instance.g_et_data_feeds_feed_name(feedName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETDataFeedsFeedName: %s\n" % e)

Parameters

Path parameters
Name Description
feedName*
String
Name of the data feed
Required

Responses

Status: 200 -


gETDataFeedsFeedNamePools

Returns all pools in a particular data feed


/data-feeds/{feedName}/pools

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds/{feedName}/pools?pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String feedName = feedName_example; // String | Name of the data feed
        Integer pageNumber = 56; // Integer | The page number of the returned pools.
        Integer pageSize = 56; // Integer | The size of a returned page of pools.
        try {
            pools result = apiInstance.gETDataFeedsFeedNamePools(feedName, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeedsFeedNamePools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String feedName = feedName_example; // String | Name of the data feed
        Integer pageNumber = 56; // Integer | The page number of the returned pools.
        Integer pageSize = 56; // Integer | The size of a returned page of pools.
        try {
            pools result = apiInstance.gETDataFeedsFeedNamePools(feedName, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETDataFeedsFeedNamePools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *feedName = feedName_example; // Name of the data feed
Integer *pageNumber = 56; // The page number of the returned pools. (default to 0)
Integer *pageSize = 56; // The size of a returned page of pools. (default to 50)

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

[apiInstance gETDataFeedsFeedNamePoolsWith:feedName
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(pools output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var feedName = feedName_example; // {{String}} Name of the data feed
var pageNumber = 56; // {{Integer}} The page number of the returned pools.
var pageSize = 56; // {{Integer}} The size of a returned page of pools.

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

namespace Example
{
    public class gETDataFeedsFeedNamePoolsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var feedName = feedName_example;  // String | Name of the data feed
            var pageNumber = 56;  // Integer | The page number of the returned pools. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of pools. (default to 50)

            try
            {
                pools result = apiInstance.gETDataFeedsFeedNamePools(feedName, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETDataFeedsFeedNamePools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$feedName = feedName_example; // String | Name of the data feed
$pageNumber = 56; // Integer | The page number of the returned pools.
$pageSize = 56; // Integer | The size of a returned page of pools.

try {
    $result = $api_instance->gETDataFeedsFeedNamePools($feedName, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETDataFeedsFeedNamePools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $feedName = feedName_example; # String | Name of the data feed
my $pageNumber = 56; # Integer | The page number of the returned pools.
my $pageSize = 56; # Integer | The size of a returned page of pools.

eval { 
    my $result = $api_instance->gETDataFeedsFeedNamePools(feedName => $feedName, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETDataFeedsFeedNamePools: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
feedName = feedName_example # String | Name of the data feed
pageNumber = 56 # Integer | The page number of the returned pools. (default to 0)
pageSize = 56 # Integer | The size of a returned page of pools. (default to 50)

try: 
    api_response = api_instance.g_et_data_feeds_feed_name_pools(feedName, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETDataFeedsFeedNamePools: %s\n" % e)

Parameters

Path parameters
Name Description
feedName*
String
Name of the data feed
Required
Query parameters
Name Description
pageNumber*
Integer
The page number of the returned pools.
Required
pageSize*
Integer
The size of a returned page of pools.
Required

Responses

Status: 200 -


gETItemClasses

Returns all item classes


/item-classes

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            item-classes result = apiInstance.gETItemClasses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClasses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            item-classes result = apiInstance.gETItemClasses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClasses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETItemClassesWithCompletionHandler: 
              ^(item-classes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETItemClassesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                item-classes result = apiInstance.gETItemClasses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClasses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETItemClasses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClasses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETItemClasses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClasses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_item_classes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClasses: %s\n" % e)

Parameters

Responses

Status: 200 -


gETItemClassesCanonicalItemTypes

Returns all canonical item types


/item-classes/canonical/item-types

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/canonical/item-types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            item-types result = apiInstance.gETItemClassesCanonicalItemTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            item-types result = apiInstance.gETItemClassesCanonicalItemTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETItemClassesCanonicalItemTypesWithCompletionHandler: 
              ^(item-types output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETItemClassesCanonicalItemTypesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                item-types result = apiInstance.gETItemClassesCanonicalItemTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesCanonicalItemTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETItemClassesCanonicalItemTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesCanonicalItemTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesCanonicalItemTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_item_classes_canonical_item_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesCanonicalItemTypes: %s\n" % e)

Parameters

Responses

Status: 200 -


gETItemClassesCanonicalItemTypesItemType

Returns canonical item type by name


/item-classes/canonical/item-types/{itemType}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/canonical/item-types/{itemType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | ID of the canonical item type
        try {
            item-type result = apiInstance.gETItemClassesCanonicalItemTypesItemType(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypesItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | ID of the canonical item type
        try {
            item-type result = apiInstance.gETItemClassesCanonicalItemTypesItemType(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypesItemType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // ID of the canonical item type

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

[apiInstance gETItemClassesCanonicalItemTypesItemTypeWith:itemType
              completionHandler: ^(item-type output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} ID of the canonical item type

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

namespace Example
{
    public class gETItemClassesCanonicalItemTypesItemTypeExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | ID of the canonical item type

            try
            {
                item-type result = apiInstance.gETItemClassesCanonicalItemTypesItemType(itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesCanonicalItemTypesItemType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | ID of the canonical item type

try {
    $result = $api_instance->gETItemClassesCanonicalItemTypesItemType($itemType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | ID of the canonical item type

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypesItemType(itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | ID of the canonical item type

try: 
    api_response = api_instance.g_et_item_classes_canonical_item_types_item_type(itemType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
ID of the canonical item type
Required

Responses

Status: 200 -


gETItemClassesCanonicalItemTypesItemTypeAttributes

Returns all canonical item type attributes by item type


/item-classes/canonical/item-types/{itemType}/attributes

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/canonical/item-types/{itemType}/attributes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | ID of the canonical item type
        try {
            canonical-attribute-definitions result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypesItemTypeAttributes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | ID of the canonical item type
        try {
            canonical-attribute-definitions result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypesItemTypeAttributes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // ID of the canonical item type

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

[apiInstance gETItemClassesCanonicalItemTypesItemTypeAttributesWith:itemType
              completionHandler: ^(canonical-attribute-definitions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} ID of the canonical item type

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

namespace Example
{
    public class gETItemClassesCanonicalItemTypesItemTypeAttributesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | ID of the canonical item type

            try
            {
                canonical-attribute-definitions result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesCanonicalItemTypesItemTypeAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | ID of the canonical item type

try {
    $result = $api_instance->gETItemClassesCanonicalItemTypesItemTypeAttributes($itemType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemTypeAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | ID of the canonical item type

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemTypeAttributes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | ID of the canonical item type

try: 
    api_response = api_instance.g_et_item_classes_canonical_item_types_item_type_attributes(itemType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemTypeAttributes: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
ID of the canonical item type
Required

Responses

Status: 200 -


gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName

Returns canonical item attribute by item type and canonical item attribute name


/item-classes/canonical/item-types/{itemType}/attributes/{attributeName}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/canonical/item-types/{itemType}/attributes/{attributeName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String attributeName = attributeName_example; // String | Name of the canonical item attribute
        String itemType = itemType_example; // String | ID of the canonical item type
        try {
            canonical-attribute-definition result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String attributeName = attributeName_example; // String | Name of the canonical item attribute
        String itemType = itemType_example; // String | ID of the canonical item type
        try {
            canonical-attribute-definition result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *attributeName = attributeName_example; // Name of the canonical item attribute
String *itemType = itemType_example; // ID of the canonical item type

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

[apiInstance gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeNameWith:attributeName
    itemType:itemType
              completionHandler: ^(canonical-attribute-definition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var attributeName = attributeName_example; // {{String}} Name of the canonical item attribute
var itemType = itemType_example; // {{String}} ID of the canonical item type

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

namespace Example
{
    public class gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeNameExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var attributeName = attributeName_example;  // String | Name of the canonical item attribute
            var itemType = itemType_example;  // String | ID of the canonical item type

            try
            {
                canonical-attribute-definition result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$attributeName = attributeName_example; // String | Name of the canonical item attribute
$itemType = itemType_example; // String | ID of the canonical item type

try {
    $result = $api_instance->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName($attributeName, $itemType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $attributeName = attributeName_example; # String | Name of the canonical item attribute
my $itemType = itemType_example; # String | ID of the canonical item type

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName => $attributeName, itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
attributeName = attributeName_example # String | Name of the canonical item attribute
itemType = itemType_example # String | ID of the canonical item type

try: 
    api_response = api_instance.g_et_item_classes_canonical_item_types_item_type_attributes_attribute_name(attributeName, itemType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName: %s\n" % e)

Parameters

Path parameters
Name Description
attributeName*
String
Name of the canonical item attribute
Required
itemType*
String
ID of the canonical item type
Required

Responses

Status: 200 -


gETItemClassesRawItemTypes

Returns all raw item types


/item-classes/raw/item-types

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/raw/item-types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            item-types result = apiInstance.gETItemClassesRawItemTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesRawItemTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            item-types result = apiInstance.gETItemClassesRawItemTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesRawItemTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETItemClassesRawItemTypesWithCompletionHandler: 
              ^(item-types output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETItemClassesRawItemTypesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                item-types result = apiInstance.gETItemClassesRawItemTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesRawItemTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETItemClassesRawItemTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesRawItemTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETItemClassesRawItemTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesRawItemTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_item_classes_raw_item_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesRawItemTypes: %s\n" % e)

Parameters

Responses

Status: 200 -


gETItemClassesRawItemTypesItemTypeAttributes

Returns attributes by item type


/item-classes/raw/item-types/{itemType}/attributes

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/raw/item-types/{itemType}/attributes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        try {
            raw-attribute-definitions result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributes(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesRawItemTypesItemTypeAttributes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        try {
            raw-attribute-definitions result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributes(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesRawItemTypesItemTypeAttributes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // The type of item to be returned

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

[apiInstance gETItemClassesRawItemTypesItemTypeAttributesWith:itemType
              completionHandler: ^(raw-attribute-definitions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} The type of item to be returned

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

namespace Example
{
    public class gETItemClassesRawItemTypesItemTypeAttributesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | The type of item to be returned

            try
            {
                raw-attribute-definitions result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributes(itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesRawItemTypesItemTypeAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | The type of item to be returned

try {
    $result = $api_instance->gETItemClassesRawItemTypesItemTypeAttributes($itemType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesRawItemTypesItemTypeAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | The type of item to be returned

eval { 
    my $result = $api_instance->gETItemClassesRawItemTypesItemTypeAttributes(itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesRawItemTypesItemTypeAttributes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | The type of item to be returned

try: 
    api_response = api_instance.g_et_item_classes_raw_item_types_item_type_attributes(itemType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesRawItemTypesItemTypeAttributes: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
The type of item to be returned
Required

Responses

Status: 200 -


gETItemClassesRawItemTypesItemTypeAttributesAttributeName

Returns raw item attribute by item type and raw item attribute name


/item-classes/raw/item-types/{itemType}/attributes/{attributeName}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/item-classes/raw/item-types/{itemType}/attributes/{attributeName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String attributeName = attributeName_example; // String | Name of the raw item attribute
        String itemType = itemType_example; // String | The type of item to be returned
        try {
            raw-attribute-definition result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesRawItemTypesItemTypeAttributesAttributeName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String attributeName = attributeName_example; // String | Name of the raw item attribute
        String itemType = itemType_example; // String | The type of item to be returned
        try {
            raw-attribute-definition result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETItemClassesRawItemTypesItemTypeAttributesAttributeName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *attributeName = attributeName_example; // Name of the raw item attribute
String *itemType = itemType_example; // The type of item to be returned

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

[apiInstance gETItemClassesRawItemTypesItemTypeAttributesAttributeNameWith:attributeName
    itemType:itemType
              completionHandler: ^(raw-attribute-definition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var attributeName = attributeName_example; // {{String}} Name of the raw item attribute
var itemType = itemType_example; // {{String}} The type of item to be returned

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

namespace Example
{
    public class gETItemClassesRawItemTypesItemTypeAttributesAttributeNameExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var attributeName = attributeName_example;  // String | Name of the raw item attribute
            var itemType = itemType_example;  // String | The type of item to be returned

            try
            {
                raw-attribute-definition result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETItemClassesRawItemTypesItemTypeAttributesAttributeName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$attributeName = attributeName_example; // String | Name of the raw item attribute
$itemType = itemType_example; // String | The type of item to be returned

try {
    $result = $api_instance->gETItemClassesRawItemTypesItemTypeAttributesAttributeName($attributeName, $itemType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETItemClassesRawItemTypesItemTypeAttributesAttributeName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $attributeName = attributeName_example; # String | Name of the raw item attribute
my $itemType = itemType_example; # String | The type of item to be returned

eval { 
    my $result = $api_instance->gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName => $attributeName, itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETItemClassesRawItemTypesItemTypeAttributesAttributeName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
attributeName = attributeName_example # String | Name of the raw item attribute
itemType = itemType_example # String | The type of item to be returned

try: 
    api_response = api_instance.g_et_item_classes_raw_item_types_item_type_attributes_attribute_name(attributeName, itemType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETItemClassesRawItemTypesItemTypeAttributesAttributeName: %s\n" % e)

Parameters

Path parameters
Name Description
attributeName*
String
Name of the raw item attribute
Required
itemType*
String
The type of item to be returned
Required

Responses

Status: 200 -


gETPools

Returns a page of pools


/pools

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools?pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer pageNumber = 56; // Integer | The page number of the returned pools.
        Integer pageSize = 56; // Integer | The size of a returned page of pools.
        try {
            pools result = apiInstance.gETPools(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer pageNumber = 56; // Integer | The page number of the returned pools.
        Integer pageSize = 56; // Integer | The size of a returned page of pools.
        try {
            pools result = apiInstance.gETPools(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *pageNumber = 56; // The page number of the returned pools. (default to 0)
Integer *pageSize = 56; // The size of a returned page of pools. (default to 50)

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

[apiInstance gETPoolsWith:pageNumber
    pageSize:pageSize
              completionHandler: ^(pools output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var pageNumber = 56; // {{Integer}} The page number of the returned pools.
var pageSize = 56; // {{Integer}} The size of a returned page of pools.

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

namespace Example
{
    public class gETPoolsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var pageNumber = 56;  // Integer | The page number of the returned pools. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of pools. (default to 50)

            try
            {
                pools result = apiInstance.gETPools(pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$pageNumber = 56; // Integer | The page number of the returned pools.
$pageSize = 56; // Integer | The size of a returned page of pools.

try {
    $result = $api_instance->gETPools($pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $pageNumber = 56; # Integer | The page number of the returned pools.
my $pageSize = 56; # Integer | The size of a returned page of pools.

eval { 
    my $result = $api_instance->gETPools(pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPools: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
pageNumber = 56 # Integer | The page number of the returned pools. (default to 0)
pageSize = 56 # Integer | The size of a returned page of pools. (default to 50)

try: 
    api_response = api_instance.g_et_pools(pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPools: %s\n" % e)

Parameters

Query parameters
Name Description
pageNumber*
Integer
The page number of the returned pools.
Required
pageSize*
Integer
The size of a returned page of pools.
Required

Responses

Status: 200 -


gETPoolsPoolName

Returns pool information by pool name


/pools/{poolName}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            pool result = apiInstance.gETPoolsPoolName(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            pool result = apiInstance.gETPoolsPoolName(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameWith:poolName
              completionHandler: ^(pool output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                pool result = apiInstance.gETPoolsPoolName(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolName($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolName(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolName: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameCompositions

Returns all compositions by pool name


/pools/{poolName}/compositions

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/compositions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            compositions result = apiInstance.gETPoolsPoolNameCompositions(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameCompositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            compositions result = apiInstance.gETPoolsPoolNameCompositions(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameCompositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameCompositionsWith:poolName
              completionHandler: ^(compositions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameCompositionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                compositions result = apiInstance.gETPoolsPoolNameCompositions(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameCompositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNameCompositions($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameCompositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNameCompositions(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameCompositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_compositions(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameCompositions: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameCompositionsActionId

Returns the composition action by ID


/pools/{poolName}/compositions/{actionId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/compositions/{actionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer actionId = 56; // Integer | The action ID of the composition
        String poolName = poolName_example; // String | Name of the pool
        try {
            composition result = apiInstance.gETPoolsPoolNameCompositionsActionId(actionId, poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameCompositionsActionId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer actionId = 56; // Integer | The action ID of the composition
        String poolName = poolName_example; // String | Name of the pool
        try {
            composition result = apiInstance.gETPoolsPoolNameCompositionsActionId(actionId, poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameCompositionsActionId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *actionId = 56; // The action ID of the composition
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameCompositionsActionIdWith:actionId
    poolName:poolName
              completionHandler: ^(composition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var actionId = 56; // {{Integer}} The action ID of the composition
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameCompositionsActionIdExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var actionId = 56;  // Integer | The action ID of the composition
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                composition result = apiInstance.gETPoolsPoolNameCompositionsActionId(actionId, poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameCompositionsActionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$actionId = 56; // Integer | The action ID of the composition
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNameCompositionsActionId($actionId, $poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameCompositionsActionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $actionId = 56; # Integer | The action ID of the composition
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNameCompositionsActionId(actionId => $actionId, poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameCompositionsActionId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
actionId = 56 # Integer | The action ID of the composition
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_compositions_action_id(actionId, poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameCompositionsActionId: %s\n" % e)

Parameters

Path parameters
Name Description
actionId*
Integer
The action ID of the composition
Required
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameItemsItemType

Returns a page of items by type and pool name


/pools/{poolName}/items/{itemType}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/items/{itemType}?q=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        String poolName = poolName_example; // String | Name of the pool
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
        Integer pageNumber = 56; // Integer | The page number of the returned items.
        Integer pageSize = 56; // Integer | The size of a returned page of items.
        try {
            data-items result = apiInstance.gETPoolsPoolNameItemsItemType(itemType, poolName, q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameItemsItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        String poolName = poolName_example; // String | Name of the pool
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
        Integer pageNumber = 56; // Integer | The page number of the returned items.
        Integer pageSize = 56; // Integer | The size of a returned page of items.
        try {
            data-items result = apiInstance.gETPoolsPoolNameItemsItemType(itemType, poolName, q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameItemsItemType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // The type of item to be returned
String *poolName = poolName_example; // Name of the pool
String *q = q_example; // Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
Integer *pageNumber = 56; // The page number of the returned items. (default to 0)
Integer *pageSize = 56; // The size of a returned page of items. (default to 50)

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

[apiInstance gETPoolsPoolNameItemsItemTypeWith:itemType
    poolName:poolName
    q:q
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(data-items output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} The type of item to be returned
var poolName = poolName_example; // {{String}} Name of the pool
var q = q_example; // {{String}} Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
var pageNumber = 56; // {{Integer}} The page number of the returned items.
var pageSize = 56; // {{Integer}} The size of a returned page of items.

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

namespace Example
{
    public class gETPoolsPoolNameItemsItemTypeExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | The type of item to be returned
            var poolName = poolName_example;  // String | Name of the pool
            var q = q_example;  // String | Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
            var pageNumber = 56;  // Integer | The page number of the returned items. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of items. (default to 50)

            try
            {
                data-items result = apiInstance.gETPoolsPoolNameItemsItemType(itemType, poolName, q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameItemsItemType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | The type of item to be returned
$poolName = poolName_example; // String | Name of the pool
$q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
$pageNumber = 56; // Integer | The page number of the returned items.
$pageSize = 56; // Integer | The size of a returned page of items.

try {
    $result = $api_instance->gETPoolsPoolNameItemsItemType($itemType, $poolName, $q, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameItemsItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | The type of item to be returned
my $poolName = poolName_example; # String | Name of the pool
my $q = q_example; # String | Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
my $pageNumber = 56; # Integer | The page number of the returned items.
my $pageSize = 56; # Integer | The size of a returned page of items.

eval { 
    my $result = $api_instance->gETPoolsPoolNameItemsItemType(itemType => $itemType, poolName => $poolName, q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameItemsItemType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | The type of item to be returned
poolName = poolName_example # String | Name of the pool
q = q_example # String | Query string in lucene syntax.  Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
pageNumber = 56 # Integer | The page number of the returned items. (default to 0)
pageSize = 56 # Integer | The size of a returned page of items. (default to 50)

try: 
    api_response = api_instance.g_et_pools_pool_name_items_item_type(itemType, poolName, q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameItemsItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
The type of item to be returned
Required
poolName*
String
Name of the pool
Required
Query parameters
Name Description
q*
String
Query string in lucene syntax. Supported terms are 'status' (0-many) or any fields that form the primary key fields and values of a canonical item.
Required
pageNumber*
Integer
The page number of the returned items.
Required
pageSize*
Integer
The size of a returned page of items.
Required

Responses

Status: 200 -


gETPoolsPoolNamePoolHistory

Returns all actions by pool name


/pools/{poolName}/pool-history

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/pool-history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            pool-actions result = apiInstance.gETPoolsPoolNamePoolHistory(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePoolHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            pool-actions result = apiInstance.gETPoolsPoolNamePoolHistory(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePoolHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNamePoolHistoryWith:poolName
              completionHandler: ^(pool-actions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNamePoolHistoryExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                pool-actions result = apiInstance.gETPoolsPoolNamePoolHistory(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNamePoolHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNamePoolHistory($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNamePoolHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNamePoolHistory(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNamePoolHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_pool_history(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNamePoolHistory: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNamePublications

Returns a page of publications by pool name. The default page size is 50.


/pools/{poolName}/publications

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/publications?pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        Integer pageNumber = 56; // Integer | The page number of the returned publications.
        Integer pageSize = 56; // Integer | The size of a returned page of publications.
        try {
            publications result = apiInstance.gETPoolsPoolNamePublications(poolName, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        Integer pageNumber = 56; // Integer | The page number of the returned publications.
        Integer pageSize = 56; // Integer | The size of a returned page of publications.
        try {
            publications result = apiInstance.gETPoolsPoolNamePublications(poolName, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePublications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool
Integer *pageNumber = 56; // The page number of the returned publications. (default to 0)
Integer *pageSize = 56; // The size of a returned page of publications. (default to 50)

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

[apiInstance gETPoolsPoolNamePublicationsWith:poolName
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(publications output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool
var pageNumber = 56; // {{Integer}} The page number of the returned publications.
var pageSize = 56; // {{Integer}} The size of a returned page of publications.

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

namespace Example
{
    public class gETPoolsPoolNamePublicationsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool
            var pageNumber = 56;  // Integer | The page number of the returned publications. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of publications. (default to 50)

            try
            {
                publications result = apiInstance.gETPoolsPoolNamePublications(poolName, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNamePublications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool
$pageNumber = 56; // Integer | The page number of the returned publications.
$pageSize = 56; // Integer | The size of a returned page of publications.

try {
    $result = $api_instance->gETPoolsPoolNamePublications($poolName, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNamePublications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool
my $pageNumber = 56; # Integer | The page number of the returned publications.
my $pageSize = 56; # Integer | The size of a returned page of publications.

eval { 
    my $result = $api_instance->gETPoolsPoolNamePublications(poolName => $poolName, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNamePublications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool
pageNumber = 56 # Integer | The page number of the returned publications. (default to 0)
pageSize = 56 # Integer | The size of a returned page of publications. (default to 50)

try: 
    api_response = api_instance.g_et_pools_pool_name_publications(poolName, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNamePublications: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required
Query parameters
Name Description
pageNumber*
Integer
The page number of the returned publications.
Required
pageSize*
Integer
The size of a returned page of publications.
Required

Responses

Status: 200 -


gETPoolsPoolNamePublicationsActionId

Returns the publication action by ID


/pools/{poolName}/publications/{actionId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/publications/{actionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer actionId = 56; // Integer | The action ID of the publication
        String poolName = poolName_example; // String | Name of the pool
        try {
            publication result = apiInstance.gETPoolsPoolNamePublicationsActionId(actionId, poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePublicationsActionId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer actionId = 56; // Integer | The action ID of the publication
        String poolName = poolName_example; // String | Name of the pool
        try {
            publication result = apiInstance.gETPoolsPoolNamePublicationsActionId(actionId, poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePublicationsActionId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *actionId = 56; // The action ID of the publication
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNamePublicationsActionIdWith:actionId
    poolName:poolName
              completionHandler: ^(publication output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var actionId = 56; // {{Integer}} The action ID of the publication
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNamePublicationsActionIdExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var actionId = 56;  // Integer | The action ID of the publication
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                publication result = apiInstance.gETPoolsPoolNamePublicationsActionId(actionId, poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNamePublicationsActionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$actionId = 56; // Integer | The action ID of the publication
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNamePublicationsActionId($actionId, $poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNamePublicationsActionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $actionId = 56; # Integer | The action ID of the publication
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNamePublicationsActionId(actionId => $actionId, poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNamePublicationsActionId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
actionId = 56 # Integer | The action ID of the publication
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_publications_action_id(actionId, poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNamePublicationsActionId: %s\n" % e)

Parameters

Path parameters
Name Description
actionId*
Integer
The action ID of the publication
Required
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNamePublicationsActionIdTargetSystemPublications

Returns a list of target system publications by action ID


/pools/{poolName}/publications/{actionId}/target-system-publications

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/publications/{actionId}/target-system-publications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer actionId = 56; // Integer | The action ID of the publication
        String poolName = poolName_example; // String | Name of the pool
        try {
            target-system-publications result = apiInstance.gETPoolsPoolNamePublicationsActionIdTargetSystemPublications(actionId, poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePublicationsActionIdTargetSystemPublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer actionId = 56; // Integer | The action ID of the publication
        String poolName = poolName_example; // String | Name of the pool
        try {
            target-system-publications result = apiInstance.gETPoolsPoolNamePublicationsActionIdTargetSystemPublications(actionId, poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNamePublicationsActionIdTargetSystemPublications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *actionId = 56; // The action ID of the publication
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNamePublicationsActionIdTargetSystemPublicationsWith:actionId
    poolName:poolName
              completionHandler: ^(target-system-publications output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var actionId = 56; // {{Integer}} The action ID of the publication
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNamePublicationsActionIdTargetSystemPublicationsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var actionId = 56;  // Integer | The action ID of the publication
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                target-system-publications result = apiInstance.gETPoolsPoolNamePublicationsActionIdTargetSystemPublications(actionId, poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNamePublicationsActionIdTargetSystemPublications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$actionId = 56; // Integer | The action ID of the publication
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications($actionId, $poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $actionId = 56; # Integer | The action ID of the publication
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications(actionId => $actionId, poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
actionId = 56 # Integer | The action ID of the publication
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_publications_action_id_target_system_publications(actionId, poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications: %s\n" % e)

Parameters

Path parameters
Name Description
actionId*
Integer
The action ID of the publication
Required
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameStatusCounts

Returns the addition for all pools of all status counts for all item types.


/pools/{poolName}/status-counts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/status-counts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            item-status-counts result = apiInstance.gETPoolsPoolNameStatusCounts(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            item-status-counts result = apiInstance.gETPoolsPoolNameStatusCounts(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameStatusCountsWith:poolName
              completionHandler: ^(item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameStatusCountsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                item-status-counts result = apiInstance.gETPoolsPoolNameStatusCounts(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameStatusCounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNameStatusCounts($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameStatusCounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNameStatusCounts(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameStatusCounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_status_counts(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameStatusCounts: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameStatusCountsCanonical

Returns the addition for all pools of all status counts for canonical items.


/pools/{poolName}/status-counts/canonical

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/status-counts/canonical"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            canonical-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonical(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCountsCanonical");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            canonical-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonical(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCountsCanonical");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameStatusCountsCanonicalWith:poolName
              completionHandler: ^(canonical-item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameStatusCountsCanonicalExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                canonical-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonical(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameStatusCountsCanonical: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNameStatusCountsCanonical($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsCanonical: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNameStatusCountsCanonical(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsCanonical: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_status_counts_canonical(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsCanonical: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameStatusCountsCanonicalPublication

Returns the addition for all pools of all status counts for canonical-publication items.


/pools/{poolName}/status-counts/canonical-publication

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/status-counts/canonical-publication"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            canonical-publication-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonicalPublication(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCountsCanonicalPublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            canonical-publication-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonicalPublication(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCountsCanonicalPublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameStatusCountsCanonicalPublicationWith:poolName
              completionHandler: ^(canonical-publication-item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameStatusCountsCanonicalPublicationExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                canonical-publication-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonicalPublication(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameStatusCountsCanonicalPublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNameStatusCountsCanonicalPublication($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsCanonicalPublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNameStatusCountsCanonicalPublication(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsCanonicalPublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_status_counts_canonical_publication(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsCanonicalPublication: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNameStatusCountsRaw

Returns the addition for all pools of all status counts for raw items.


/pools/{poolName}/status-counts/raw

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/status-counts/raw"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            raw-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsRaw(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCountsRaw");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        try {
            raw-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsRaw(poolName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETPoolsPoolNameStatusCountsRaw");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool

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

[apiInstance gETPoolsPoolNameStatusCountsRawWith:poolName
              completionHandler: ^(raw-item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool

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

namespace Example
{
    public class gETPoolsPoolNameStatusCountsRawExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                raw-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsRaw(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETPoolsPoolNameStatusCountsRaw: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool

try {
    $result = $api_instance->gETPoolsPoolNameStatusCountsRaw($poolName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsRaw: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool

eval { 
    my $result = $api_instance->gETPoolsPoolNameStatusCountsRaw(poolName => $poolName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsRaw: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool

try: 
    api_response = api_instance.g_et_pools_pool_name_status_counts_raw(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETPoolsPoolNameStatusCountsRaw: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETRawItemsItemId

Returns raw item by item id


/raw-items/{itemId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/raw-items/{itemId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer itemId = 56; // Integer | ID of the raw item
        try {
            data-item result = apiInstance.gETRawItemsItemId(itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETRawItemsItemId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer itemId = 56; // Integer | ID of the raw item
        try {
            data-item result = apiInstance.gETRawItemsItemId(itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETRawItemsItemId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *itemId = 56; // ID of the raw item

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

[apiInstance gETRawItemsItemIdWith:itemId
              completionHandler: ^(data-item output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemId = 56; // {{Integer}} ID of the raw item

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

namespace Example
{
    public class gETRawItemsItemIdExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemId = 56;  // Integer | ID of the raw item

            try
            {
                data-item result = apiInstance.gETRawItemsItemId(itemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETRawItemsItemId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemId = 56; // Integer | ID of the raw item

try {
    $result = $api_instance->gETRawItemsItemId($itemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETRawItemsItemId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemId = 56; # Integer | ID of the raw item

eval { 
    my $result = $api_instance->gETRawItemsItemId(itemId => $itemId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETRawItemsItemId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemId = 56 # Integer | ID of the raw item

try: 
    api_response = api_instance.g_et_raw_items_item_id(itemId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETRawItemsItemId: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Integer
ID of the raw item
Required

Responses

Status: 200 -


gETStatus

Returns the status of the Data Hub


/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/text"\
"https://{hostname}:{port}/{application}/{version}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.gETStatus();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.gETStatus();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETStatusWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETStatusExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                apiInstance.gETStatus();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $api_instance->gETStatus();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    $api_instance->gETStatus();
};
if ($@) {
    warn "Exception when calling DefaultApi->gETStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_instance.g_et_status()
except ApiException as e:
    print("Exception when calling DefaultApi->gETStatus: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCounts

Returns the addition for all pools of all status counts for all item types.


/status-counts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/status-counts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            item-status-counts result = apiInstance.gETStatusCounts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            item-status-counts result = apiInstance.gETStatusCounts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETStatusCountsWithCompletionHandler: 
              ^(item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETStatusCountsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                item-status-counts result = apiInstance.gETStatusCounts();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETStatusCounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETStatusCounts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETStatusCounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETStatusCounts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETStatusCounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_status_counts()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETStatusCounts: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCountsCanonical

Returns the addition for all pools of all status counts for canonical items.


/status-counts/canonical

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/status-counts/canonical"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            canonical-item-status-counts result = apiInstance.gETStatusCountsCanonical();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCountsCanonical");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            canonical-item-status-counts result = apiInstance.gETStatusCountsCanonical();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCountsCanonical");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETStatusCountsCanonicalWithCompletionHandler: 
              ^(canonical-item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETStatusCountsCanonicalExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                canonical-item-status-counts result = apiInstance.gETStatusCountsCanonical();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETStatusCountsCanonical: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETStatusCountsCanonical();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETStatusCountsCanonical: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETStatusCountsCanonical();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETStatusCountsCanonical: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_status_counts_canonical()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETStatusCountsCanonical: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCountsCanonicalPublication

Returns the addition for all pools of all status counts for canonical-publication items.


/status-counts/canonical-publication

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/status-counts/canonical-publication"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            canonical-publication-item-status-counts result = apiInstance.gETStatusCountsCanonicalPublication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCountsCanonicalPublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            canonical-publication-item-status-counts result = apiInstance.gETStatusCountsCanonicalPublication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCountsCanonicalPublication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETStatusCountsCanonicalPublicationWithCompletionHandler: 
              ^(canonical-publication-item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETStatusCountsCanonicalPublicationExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                canonical-publication-item-status-counts result = apiInstance.gETStatusCountsCanonicalPublication();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETStatusCountsCanonicalPublication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETStatusCountsCanonicalPublication();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETStatusCountsCanonicalPublication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETStatusCountsCanonicalPublication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETStatusCountsCanonicalPublication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_status_counts_canonical_publication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETStatusCountsCanonicalPublication: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCountsRaw

Returns the addition for all pools of all status counts for raw items.


/status-counts/raw

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/status-counts/raw"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            raw-item-status-counts result = apiInstance.gETStatusCountsRaw();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCountsRaw");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            raw-item-status-counts result = apiInstance.gETStatusCountsRaw();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETStatusCountsRaw");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETStatusCountsRawWithCompletionHandler: 
              ^(raw-item-status-counts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETStatusCountsRawExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                raw-item-status-counts result = apiInstance.gETStatusCountsRaw();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETStatusCountsRaw: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->gETStatusCountsRaw();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETStatusCountsRaw: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->gETStatusCountsRaw();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETStatusCountsRaw: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.g_et_status_counts_raw()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETStatusCountsRaw: %s\n" % e)

Parameters

Responses

Status: 200 -


gETTargetSystemPublications

Returns a page of target-system-publications


/target-system-publications

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/target-system-publications?q=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
        Integer pageNumber = 56; // Integer | The page number of the returned target-system-publications.
        Integer pageSize = 56; // Integer | The size of a returned page of target-system-publications.
        try {
            target-system-publications result = apiInstance.gETTargetSystemPublications(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
        Integer pageNumber = 56; // Integer | The page number of the returned target-system-publications.
        Integer pageSize = 56; // Integer | The size of a returned page of target-system-publications.
        try {
            target-system-publications result = apiInstance.gETTargetSystemPublications(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *q = q_example; // Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
Integer *pageNumber = 56; // The page number of the returned target-system-publications. (default to 0)
Integer *pageSize = 56; // The size of a returned page of target-system-publications. (default to 50)

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

[apiInstance gETTargetSystemPublicationsWith:q
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(target-system-publications output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var q = q_example; // {{String}} Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
var pageNumber = 56; // {{Integer}} The page number of the returned target-system-publications.
var pageSize = 56; // {{Integer}} The size of a returned page of target-system-publications.

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

namespace Example
{
    public class gETTargetSystemPublicationsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var q = q_example;  // String | Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
            var pageNumber = 56;  // Integer | The page number of the returned target-system-publications. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of target-system-publications. (default to 50)

            try
            {
                target-system-publications result = apiInstance.gETTargetSystemPublications(q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETTargetSystemPublications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
$pageNumber = 56; // Integer | The page number of the returned target-system-publications.
$pageSize = 56; // Integer | The size of a returned page of target-system-publications.

try {
    $result = $api_instance->gETTargetSystemPublications($q, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETTargetSystemPublications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $q = q_example; # String | Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
my $pageNumber = 56; # Integer | The page number of the returned target-system-publications.
my $pageSize = 56; # Integer | The size of a returned page of target-system-publications.

eval { 
    my $result = $api_instance->gETTargetSystemPublications(q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETTargetSystemPublications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
q = q_example # String | Query string in lucene syntax.  Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
pageNumber = 56 # Integer | The page number of the returned target-system-publications. (default to 0)
pageSize = 56 # Integer | The size of a returned page of target-system-publications. (default to 50)

try: 
    api_response = api_instance.g_et_target_system_publications(q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETTargetSystemPublications: %s\n" % e)

Parameters

Query parameters
Name Description
q*
String
Query string in lucene syntax. Supported terms are 'status' (0-many), startDate'(0-1), 'endDate'(0-1), 'poolName'(0-1), 'targetSystemName(0-1)'. Date format is [>,>=,<,<=]+'yyyyMMddHHmm'
Required
pageNumber*
Integer
The page number of the returned target-system-publications.
Required
pageSize*
Integer
The size of a returned page of target-system-publications.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationId

Returns a particular target system publication by publication ID


/target-system-publications/{publicationId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/target-system-publications/{publicationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        try {
            target-system-publication result = apiInstance.gETTargetSystemPublicationsPublicationId(publicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        try {
            target-system-publication result = apiInstance.gETTargetSystemPublicationsPublicationId(publicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *publicationId = publicationId_example; // The publication ID of the target system publication

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

[apiInstance gETTargetSystemPublicationsPublicationIdWith:publicationId
              completionHandler: ^(target-system-publication output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var publicationId = publicationId_example; // {{String}} The publication ID of the target system publication

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

namespace Example
{
    public class gETTargetSystemPublicationsPublicationIdExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var publicationId = publicationId_example;  // String | The publication ID of the target system publication

            try
            {
                target-system-publication result = apiInstance.gETTargetSystemPublicationsPublicationId(publicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETTargetSystemPublicationsPublicationId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$publicationId = publicationId_example; // String | The publication ID of the target system publication

try {
    $result = $api_instance->gETTargetSystemPublicationsPublicationId($publicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $publicationId = publicationId_example; # String | The publication ID of the target system publication

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationId(publicationId => $publicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
publicationId = publicationId_example # String | The publication ID of the target system publication

try: 
    api_response = api_instance.g_et_target_system_publications_publication_id(publicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationId: %s\n" % e)

Parameters

Path parameters
Name Description
publicationId*
String
The publication ID of the target system publication
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationIdErrors

Returns all target system publication errors by publication ID


/target-system-publications/{publicationId}/errors

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/target-system-publications/{publicationId}/errors?pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        Integer pageNumber = 56; // Integer | The page number of the returned errors.
        Integer pageSize = 56; // Integer | The size of a returned page of errors.
        try {
            errors result = apiInstance.gETTargetSystemPublicationsPublicationIdErrors(publicationId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationIdErrors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        Integer pageNumber = 56; // Integer | The page number of the returned errors.
        Integer pageSize = 56; // Integer | The size of a returned page of errors.
        try {
            errors result = apiInstance.gETTargetSystemPublicationsPublicationIdErrors(publicationId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationIdErrors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *publicationId = publicationId_example; // The publication ID of the target system publication
Integer *pageNumber = 56; // The page number of the returned errors. (default to 0)
Integer *pageSize = 56; // The size of a returned page of errors. (default to 50)

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

[apiInstance gETTargetSystemPublicationsPublicationIdErrorsWith:publicationId
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(errors output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var publicationId = publicationId_example; // {{String}} The publication ID of the target system publication
var pageNumber = 56; // {{Integer}} The page number of the returned errors.
var pageSize = 56; // {{Integer}} The size of a returned page of errors.

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

namespace Example
{
    public class gETTargetSystemPublicationsPublicationIdErrorsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var publicationId = publicationId_example;  // String | The publication ID of the target system publication
            var pageNumber = 56;  // Integer | The page number of the returned errors. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of errors. (default to 50)

            try
            {
                errors result = apiInstance.gETTargetSystemPublicationsPublicationIdErrors(publicationId, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETTargetSystemPublicationsPublicationIdErrors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$publicationId = publicationId_example; // String | The publication ID of the target system publication
$pageNumber = 56; // Integer | The page number of the returned errors.
$pageSize = 56; // Integer | The size of a returned page of errors.

try {
    $result = $api_instance->gETTargetSystemPublicationsPublicationIdErrors($publicationId, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdErrors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $publicationId = publicationId_example; # String | The publication ID of the target system publication
my $pageNumber = 56; # Integer | The page number of the returned errors.
my $pageSize = 56; # Integer | The size of a returned page of errors.

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationIdErrors(publicationId => $publicationId, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdErrors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
publicationId = publicationId_example # String | The publication ID of the target system publication
pageNumber = 56 # Integer | The page number of the returned errors. (default to 0)
pageSize = 56 # Integer | The size of a returned page of errors. (default to 50)

try: 
    api_response = api_instance.g_et_target_system_publications_publication_id_errors(publicationId, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdErrors: %s\n" % e)

Parameters

Path parameters
Name Description
publicationId*
String
The publication ID of the target system publication
Required
Query parameters
Name Description
pageNumber*
Integer
The page number of the returned errors.
Required
pageSize*
Integer
The size of a returned page of errors.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationIdItemStatuses

Returns all canonical item publication status items by publication ID


/target-system-publications/{publicationId}/item-statuses

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/target-system-publications/{publicationId}/item-statuses?q=&status=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
        String status = status_example; // String | A list of statuses to search for
        Integer pageNumber = 56; // Integer | The page number of the returned item-statuses.
        Integer pageSize = 56; // Integer | The size of a returned page of item-statuses.
        try {
            canonicalItemPublicationStatusItemList result = apiInstance.gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId, q, status, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationIdItemStatuses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
        String status = status_example; // String | A list of statuses to search for
        Integer pageNumber = 56; // Integer | The page number of the returned item-statuses.
        Integer pageSize = 56; // Integer | The size of a returned page of item-statuses.
        try {
            canonicalItemPublicationStatusItemList result = apiInstance.gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId, q, status, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationIdItemStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *publicationId = publicationId_example; // The publication ID of the target system publication
String *q = q_example; // Query string in lucene syntax.  Supported terms are 'status' (0-many)
String *status = status_example; // A list of statuses to search for
Integer *pageNumber = 56; // The page number of the returned item-statuses. (default to 0)
Integer *pageSize = 56; // The size of a returned page of item-statuses. (default to 50)

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

[apiInstance gETTargetSystemPublicationsPublicationIdItemStatusesWith:publicationId
    q:q
    status:status
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(canonicalItemPublicationStatusItemList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var publicationId = publicationId_example; // {{String}} The publication ID of the target system publication
var q = q_example; // {{String}} Query string in lucene syntax.  Supported terms are 'status' (0-many)
var status = status_example; // {{String}} A list of statuses to search for
var pageNumber = 56; // {{Integer}} The page number of the returned item-statuses.
var pageSize = 56; // {{Integer}} The size of a returned page of item-statuses.

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

namespace Example
{
    public class gETTargetSystemPublicationsPublicationIdItemStatusesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var publicationId = publicationId_example;  // String | The publication ID of the target system publication
            var q = q_example;  // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
            var status = status_example;  // String | A list of statuses to search for
            var pageNumber = 56;  // Integer | The page number of the returned item-statuses. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of item-statuses. (default to 50)

            try
            {
                canonicalItemPublicationStatusItemList result = apiInstance.gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId, q, status, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETTargetSystemPublicationsPublicationIdItemStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$publicationId = publicationId_example; // String | The publication ID of the target system publication
$q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
$status = status_example; // String | A list of statuses to search for
$pageNumber = 56; // Integer | The page number of the returned item-statuses.
$pageSize = 56; // Integer | The size of a returned page of item-statuses.

try {
    $result = $api_instance->gETTargetSystemPublicationsPublicationIdItemStatuses($publicationId, $q, $status, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdItemStatuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $publicationId = publicationId_example; # String | The publication ID of the target system publication
my $q = q_example; # String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
my $status = status_example; # String | A list of statuses to search for
my $pageNumber = 56; # Integer | The page number of the returned item-statuses.
my $pageSize = 56; # Integer | The size of a returned page of item-statuses.

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId => $publicationId, q => $q, status => $status, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdItemStatuses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
publicationId = publicationId_example # String | The publication ID of the target system publication
q = q_example # String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
status = status_example # String | A list of statuses to search for
pageNumber = 56 # Integer | The page number of the returned item-statuses. (default to 0)
pageSize = 56 # Integer | The size of a returned page of item-statuses. (default to 50)

try: 
    api_response = api_instance.g_et_target_system_publications_publication_id_item_statuses(publicationId, q, status, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdItemStatuses: %s\n" % e)

Parameters

Path parameters
Name Description
publicationId*
String
The publication ID of the target system publication
Required
Query parameters
Name Description
q*
String
Query string in lucene syntax. Supported terms are 'status' (0-many)
Required
status*
String
A list of statuses to search for
Required
pageNumber*
Integer
The page number of the returned item-statuses.
Required
pageSize*
Integer
The size of a returned page of item-statuses.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationIdItemsItemType

Returns all items by publication ID and type


/target-system-publications/{publicationId}/items/{itemType}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/target-system-publications/{publicationId}/items/{itemType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        try {
            data-items result = apiInstance.gETTargetSystemPublicationsPublicationIdItemsItemType(itemType, publicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationIdItemsItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String itemType = itemType_example; // String | The type of item to be returned
        String publicationId = publicationId_example; // String | The publication ID of the target system publication
        try {
            data-items result = apiInstance.gETTargetSystemPublicationsPublicationIdItemsItemType(itemType, publicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystemPublicationsPublicationIdItemsItemType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemType = itemType_example; // The type of item to be returned
String *publicationId = publicationId_example; // The publication ID of the target system publication

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

[apiInstance gETTargetSystemPublicationsPublicationIdItemsItemTypeWith:itemType
    publicationId:publicationId
              completionHandler: ^(data-items output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var itemType = itemType_example; // {{String}} The type of item to be returned
var publicationId = publicationId_example; // {{String}} The publication ID of the target system publication

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

namespace Example
{
    public class gETTargetSystemPublicationsPublicationIdItemsItemTypeExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var itemType = itemType_example;  // String | The type of item to be returned
            var publicationId = publicationId_example;  // String | The publication ID of the target system publication

            try
            {
                data-items result = apiInstance.gETTargetSystemPublicationsPublicationIdItemsItemType(itemType, publicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETTargetSystemPublicationsPublicationIdItemsItemType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$itemType = itemType_example; // String | The type of item to be returned
$publicationId = publicationId_example; // String | The publication ID of the target system publication

try {
    $result = $api_instance->gETTargetSystemPublicationsPublicationIdItemsItemType($itemType, $publicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdItemsItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $itemType = itemType_example; # String | The type of item to be returned
my $publicationId = publicationId_example; # String | The publication ID of the target system publication

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationIdItemsItemType(itemType => $itemType, publicationId => $publicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdItemsItemType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
itemType = itemType_example # String | The type of item to be returned
publicationId = publicationId_example # String | The publication ID of the target system publication

try: 
    api_response = api_instance.g_et_target_system_publications_publication_id_items_item_type(itemType, publicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETTargetSystemPublicationsPublicationIdItemsItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
The type of item to be returned
Required
publicationId*
String
The publication ID of the target system publication
Required

Responses

Status: 200 -


gETTargetSystems

Returns all target systems


/target-systems

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://{hostname}:{port}/{application}/{version}/target-systems?pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer pageNumber = 56; // Integer | The page number of the returned target-systems.
        Integer pageSize = 56; // Integer | The size of a returned page of target-systems.
        try {
            target-systems result = apiInstance.gETTargetSystems(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer pageNumber = 56; // Integer | The page number of the returned target-systems.
        Integer pageSize = 56; // Integer | The size of a returned page of target-systems.
        try {
            target-systems result = apiInstance.gETTargetSystems(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETTargetSystems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *pageNumber = 56; // The page number of the returned target-systems. (default to 0)
Integer *pageSize = 56; // The size of a returned page of target-systems. (default to 50)

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

[apiInstance gETTargetSystemsWith:pageNumber
    pageSize:pageSize
              completionHandler: ^(target-systems output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var pageNumber = 56; // {{Integer}} The page number of the returned target-systems.
var pageSize = 56; // {{Integer}} The size of a returned page of target-systems.

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

namespace Example
{
    public class gETTargetSystemsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var pageNumber = 56;  // Integer | The page number of the returned target-systems. (default to 0)
            var pageSize = 56;  // Integer | The size of a returned page of target-systems. (default to 50)

            try
            {
                target-systems result = apiInstance.gETTargetSystems(pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETTargetSystems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$pageNumber = 56; // Integer | The page number of the returned target-systems.
$pageSize = 56; // Integer | The size of a returned page of target-systems.

try {
    $result = $api_instance->gETTargetSystems($pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETTargetSystems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $pageNumber = 56; # Integer | The page number of the returned target-systems.
my $pageSize = 56; # Integer | The size of a returned page of target-systems.

eval { 
    my $result = $api_instance->gETTargetSystems(pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->gETTargetSystems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
pageNumber = 56 # Integer | The page number of the returned target-systems. (default to 0)
pageSize = 56 # Integer | The size of a returned page of target-systems. (default to 50)

try: 
    api_response = api_instance.g_et_target_systems(pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->gETTargetSystems: %s\n" % e)

Parameters

Query parameters
Name Description
pageNumber*
Integer
The page number of the returned target-systems.
Required
pageSize*
Integer
The size of a returned page of target-systems.
Required

Responses

Status: 200 -


gETVersion

Returns the version of the Data Hub that is currently running


/version

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/text"\
"https://{hostname}:{port}/{application}/{version}/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.gETVersion();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.gETVersion();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#gETVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

[apiInstance gETVersionWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class gETVersionExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                apiInstance.gETVersion();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.gETVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $api_instance->gETVersion();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->gETVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    $api_instance->gETVersion();
};
if ($@) {
    warn "Exception when calling DefaultApi->gETVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_instance.g_et_version()
except ApiException as e:
    print("Exception when calling DefaultApi->gETVersion: %s\n" % e)

Parameters

Responses

Status: 200 -


pOSTDataFeeds

Creates a new data feed in the Data Hub


/data-feeds

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Data-feed body = ; // Data-feed | 
        try {
            data-feed result = apiInstance.pOSTDataFeeds(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTDataFeeds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Data-feed body = ; // Data-feed | 
        try {
            data-feed result = apiInstance.pOSTDataFeeds(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTDataFeeds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Data-feed *body = ; //  (optional)

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

[apiInstance pOSTDataFeedsWith:body
              completionHandler: ^(data-feed output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var opts = { 
  'body':  // {{Data-feed}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pOSTDataFeeds(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pOSTDataFeedsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var body = new Data-feed(); // Data-feed |  (optional) 

            try
            {
                data-feed result = apiInstance.pOSTDataFeeds(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pOSTDataFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Data-feed | 

try {
    $result = $api_instance->pOSTDataFeeds($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pOSTDataFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Data-feed->new(); # Data-feed | 

eval { 
    my $result = $api_instance->pOSTDataFeeds(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pOSTDataFeeds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body =  # Data-feed |  (optional)

try: 
    api_response = api_instance.p_ost_data_feeds(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pOSTDataFeeds: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String

pOSTDataFeedsFeedNamePools

Creates a new pool


/data-feeds/{feedName}/pools

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://{hostname}:{port}/{application}/{version}/data-feeds/{feedName}/pools"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String feedName = feedName_example; // String | Name of the data feed
        Pool body = ; // Pool | 
        try {
            pool result = apiInstance.pOSTDataFeedsFeedNamePools(feedName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTDataFeedsFeedNamePools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String feedName = feedName_example; // String | Name of the data feed
        Pool body = ; // Pool | 
        try {
            pool result = apiInstance.pOSTDataFeedsFeedNamePools(feedName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTDataFeedsFeedNamePools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *feedName = feedName_example; // Name of the data feed
Pool *body = ; //  (optional)

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

[apiInstance pOSTDataFeedsFeedNamePoolsWith:feedName
    body:body
              completionHandler: ^(pool output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var feedName = feedName_example; // {{String}} Name of the data feed
var opts = { 
  'body':  // {{Pool}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pOSTDataFeedsFeedNamePools(feedName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pOSTDataFeedsFeedNamePoolsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var feedName = feedName_example;  // String | Name of the data feed
            var body = new Pool(); // Pool |  (optional) 

            try
            {
                pool result = apiInstance.pOSTDataFeedsFeedNamePools(feedName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pOSTDataFeedsFeedNamePools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$feedName = feedName_example; // String | Name of the data feed
$body = ; // Pool | 

try {
    $result = $api_instance->pOSTDataFeedsFeedNamePools($feedName, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pOSTDataFeedsFeedNamePools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $feedName = feedName_example; # String | Name of the data feed
my $body = WWW::SwaggerClient::Object::Pool->new(); # Pool | 

eval { 
    my $result = $api_instance->pOSTDataFeedsFeedNamePools(feedName => $feedName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pOSTDataFeedsFeedNamePools: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
feedName = feedName_example # String | Name of the data feed
body =  # Pool |  (optional)

try: 
    api_response = api_instance.p_ost_data_feeds_feed_name_pools(feedName, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pOSTDataFeedsFeedNamePools: %s\n" % e)

Parameters

Path parameters
Name Description
feedName*
String
Name of the data feed
Required
Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String

pOSTExtensions

Creates a new Data Hub extension based on the XML provided in the body. The XML should conform to datahub-metadata-schema-1.3.0.xsd


/extensions

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Content-Type: application/xml"\
"https://{hostname}:{port}/{application}/{version}/extensions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String body = ; // String | 
        try {
            apiInstance.pOSTExtensions(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTExtensions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String body = ; // String | 
        try {
            apiInstance.pOSTExtensions(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTExtensions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *body = ; //  (optional)

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

[apiInstance pOSTExtensionsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class pOSTExtensionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var body = new String(); // String |  (optional) 

            try
            {
                apiInstance.pOSTExtensions(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pOSTExtensions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // String | 

try {
    $api_instance->pOSTExtensions($body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pOSTExtensions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    $api_instance->pOSTExtensions(body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->pOSTExtensions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_instance.p_ost_extensions(body=body)
except ApiException as e:
    print("Exception when calling DefaultApi->pOSTExtensions: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Extension was created successfully

Status: 400 - Extension was not created, XML was invalid


pOSTPools

Creates a new pool


/pools

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

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

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Pool body = ; // Pool | 
        try {
            pool result = apiInstance.pOSTPools(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTPools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Pool *body = ; //  (optional)

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

[apiInstance pOSTPoolsWith:body
              completionHandler: ^(pool output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class pOSTPoolsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var body = new Pool(); // Pool |  (optional) 

            try
            {
                pool result = apiInstance.pOSTPools(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pOSTPools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Pool | 

try {
    $result = $api_instance->pOSTPools($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pOSTPools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->pOSTPools(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pOSTPools: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    api_response = api_instance.p_ost_pools(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pOSTPools: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String

pOSTPoolsPoolNameCompositions

Initiates composition by pool name


/pools/{poolName}/compositions

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/compositions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        Composition body = ; // Composition | 
        try {
            composition result = apiInstance.pOSTPoolsPoolNameCompositions(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTPoolsPoolNameCompositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        Composition body = ; // Composition | 
        try {
            composition result = apiInstance.pOSTPoolsPoolNameCompositions(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTPoolsPoolNameCompositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool
Composition *body = ; //  (optional)

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

[apiInstance pOSTPoolsPoolNameCompositionsWith:poolName
    body:body
              completionHandler: ^(composition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool
var opts = { 
  'body':  // {{Composition}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pOSTPoolsPoolNameCompositions(poolName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pOSTPoolsPoolNameCompositionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool
            var body = new Composition(); // Composition |  (optional) 

            try
            {
                composition result = apiInstance.pOSTPoolsPoolNameCompositions(poolName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pOSTPoolsPoolNameCompositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool
$body = ; // Composition | 

try {
    $result = $api_instance->pOSTPoolsPoolNameCompositions($poolName, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pOSTPoolsPoolNameCompositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool
my $body = WWW::SwaggerClient::Object::Composition->new(); # Composition | 

eval { 
    my $result = $api_instance->pOSTPoolsPoolNameCompositions(poolName => $poolName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pOSTPoolsPoolNameCompositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool
body =  # Composition |  (optional)

try: 
    api_response = api_instance.p_ost_pools_pool_name_compositions(poolName, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pOSTPoolsPoolNameCompositions: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required
Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String

pOSTPoolsPoolNamePublications

Initiates publication by pool name


/pools/{poolName}/publications

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://{hostname}:{port}/{application}/{version}/pools/{poolName}/publications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: Basic_Authentication
        HttpBasicAuth Basic_Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic_Authentication");
        Basic_Authentication.setUsername("YOUR USERNAME");
        Basic_Authentication.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        Publication body = ; // Publication | 
        try {
            publication result = apiInstance.pOSTPoolsPoolNamePublications(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTPoolsPoolNamePublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String poolName = poolName_example; // String | Name of the pool
        Publication body = ; // Publication | 
        try {
            publication result = apiInstance.pOSTPoolsPoolNamePublications(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pOSTPoolsPoolNamePublications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Basic_Authentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *poolName = poolName_example; // Name of the pool
Publication *body = ; //  (optional)

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

[apiInstance pOSTPoolsPoolNamePublicationsWith:poolName
    body:body
              completionHandler: ^(publication output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataHub = require('data_hub');
var defaultClient = DataHub.ApiClient.instance;
// Configure HTTP basic authorization: Basic_Authentication
var Basic_Authentication = defaultClient.authentications['Basic_Authentication'];
Basic_Authentication.username = 'YOUR USERNAME'
Basic_Authentication.password = 'YOUR PASSWORD'

var api = new DataHub.DefaultApi()
var poolName = poolName_example; // {{String}} Name of the pool
var opts = { 
  'body':  // {{Publication}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pOSTPoolsPoolNamePublications(poolName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pOSTPoolsPoolNamePublicationsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic_Authentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var poolName = poolName_example;  // String | Name of the pool
            var body = new Publication(); // Publication |  (optional) 

            try
            {
                publication result = apiInstance.pOSTPoolsPoolNamePublications(poolName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pOSTPoolsPoolNamePublications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic_Authentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$poolName = poolName_example; // String | Name of the pool
$body = ; // Publication | 

try {
    $result = $api_instance->pOSTPoolsPoolNamePublications($poolName, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pOSTPoolsPoolNamePublications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $poolName = poolName_example; # String | Name of the pool
my $body = WWW::SwaggerClient::Object::Publication->new(); # Publication | 

eval { 
    my $result = $api_instance->pOSTPoolsPoolNamePublications(poolName => $poolName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pOSTPoolsPoolNamePublications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic_Authentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
poolName = poolName_example # String | Name of the pool
body =  # Publication |  (optional)

try: 
    api_response = api_instance.p_ost_pools_pool_name_publications(poolName, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pOSTPoolsPoolNamePublications: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required
Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String