Data Hub

CanonicalItems

gETCanonicalItemsItemId

Retrieves a canonical item.

Retrieves the specified canonical item.


/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.CanonicalItemsApi;

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

public class CanonicalItemsApiExample {

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

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

public class CanonicalItemsApiExample {

    public static void main(String[] args) {
        CanonicalItemsApi apiInstance = new CanonicalItemsApi();
        Integer itemId = 56; // Integer | Canonical item identifier.
        try {
            data-item result = apiInstance.gETCanonicalItemsItemId(itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CanonicalItemsApi#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; // Canonical item identifier.

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

// Retrieves a canonical item.
[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.CanonicalItemsApi()
var itemId = 56; // {{Integer}} Canonical item identifier.

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 CanonicalItemsApi();
            var itemId = 56;  // Integer | Canonical item identifier.

            try
            {
                // Retrieves a canonical item.
                data-item result = apiInstance.gETCanonicalItemsItemId(itemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CanonicalItemsApi.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\ApiCanonicalItemsApi();
$itemId = 56; // Integer | Canonical item identifier.

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

my $api_instance = WWW::SwaggerClient::CanonicalItemsApi->new();
my $itemId = 56; # Integer | Canonical item identifier.

eval { 
    my $result = $api_instance->gETCanonicalItemsItemId(itemId => $itemId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CanonicalItemsApi->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.CanonicalItemsApi()
itemId = 56 # Integer | Canonical item identifier.

try: 
    # Retrieves a canonical item.
    api_response = api_instance.g_et_canonical_items_item_id(itemId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CanonicalItemsApi->gETCanonicalItemsItemId: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Integer
Canonical item identifier.
Required

Responses

Status: 200 -


Compositions

gETCompositions

Retrieves compositions.

Retrieves all compositions. When raw items are composed, it results in a canonical item.


/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.CompositionsApi;

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

public class CompositionsApiExample {

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

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

public class CompositionsApiExample {

    public static void main(String[] args) {
        CompositionsApi apiInstance = new CompositionsApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
        Integer pageNumber = 56; // Integer | Page number of the returned compositions.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            compositions result = apiInstance.gETCompositions(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompositionsApi#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; // Page number of the returned compositions. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves compositions.
[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.CompositionsApi()
var q = q_example; // {{String}} Query string in lucene syntax.  Supported terms are 'status' (0-many)
var pageNumber = 56; // {{Integer}} Page number of the returned compositions.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 CompositionsApi();
            var q = q_example;  // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
            var pageNumber = 56;  // Integer | Page number of the returned compositions. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves compositions.
                compositions result = apiInstance.gETCompositions(q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompositionsApi.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\ApiCompositionsApi();
$q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
$pageNumber = 56; // Integer | Page number of the returned compositions.
$pageSize = 56; // Integer | Number of results returned per page.

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

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

eval { 
    my $result = $api_instance->gETCompositions(q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompositionsApi->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.CompositionsApi()
q = q_example # String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
pageNumber = 56 # Integer | Page number of the returned compositions. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves compositions.
    api_response = api_instance.g_et_compositions(q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompositionsApi->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
Page number of the returned compositions.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETCompositionsCompositionId

Retrieves a composition.

Retrieves the specified composition.


/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.CompositionsApi;

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

public class CompositionsApiExample {

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

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

public class CompositionsApiExample {

    public static void main(String[] args) {
        CompositionsApi apiInstance = new CompositionsApi();
        Integer compositionId = 56; // Integer | Composition action identifier.
        try {
            composition result = apiInstance.gETCompositionsCompositionId(compositionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompositionsApi#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; // Composition action identifier.

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

// Retrieves a composition.
[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.CompositionsApi()
var compositionId = 56; // {{Integer}} Composition action identifier.

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 CompositionsApi();
            var compositionId = 56;  // Integer | Composition action identifier.

            try
            {
                // Retrieves a composition.
                composition result = apiInstance.gETCompositionsCompositionId(compositionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompositionsApi.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\ApiCompositionsApi();
$compositionId = 56; // Integer | Composition action identifier.

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

my $api_instance = WWW::SwaggerClient::CompositionsApi->new();
my $compositionId = 56; # Integer | Composition action identifier.

eval { 
    my $result = $api_instance->gETCompositionsCompositionId(compositionId => $compositionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompositionsApi->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.CompositionsApi()
compositionId = 56 # Integer | Composition action identifier.

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

Parameters

Path parameters
Name Description
compositionId*
Integer
Composition action identifier.
Required

Responses

Status: 200 -


gETCompositionsCompositionIdErrors

Retrieves composition errors.

Retrieves errors of the specified composition.


/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.CompositionsApi;

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

public class CompositionsApiExample {

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

        CompositionsApi apiInstance = new CompositionsApi();
        Integer compositionId = 56; // Integer | Composition action identifier.
        Integer pageNumber = 56; // Integer | Page number of the returned composition errors.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            errors result = apiInstance.gETCompositionsCompositionIdErrors(compositionId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompositionsApi#gETCompositionsCompositionIdErrors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompositionsApi;

public class CompositionsApiExample {

    public static void main(String[] args) {
        CompositionsApi apiInstance = new CompositionsApi();
        Integer compositionId = 56; // Integer | Composition action identifier.
        Integer pageNumber = 56; // Integer | Page number of the returned composition errors.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            errors result = apiInstance.gETCompositionsCompositionIdErrors(compositionId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompositionsApi#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; // Composition action identifier.
Integer *pageNumber = 56; // Page number of the returned composition errors. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves composition errors.
[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.CompositionsApi()
var compositionId = 56; // {{Integer}} Composition action identifier.
var pageNumber = 56; // {{Integer}} Page number of the returned composition errors.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 CompositionsApi();
            var compositionId = 56;  // Integer | Composition action identifier.
            var pageNumber = 56;  // Integer | Page number of the returned composition errors. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves composition errors.
                errors result = apiInstance.gETCompositionsCompositionIdErrors(compositionId, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompositionsApi.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\ApiCompositionsApi();
$compositionId = 56; // Integer | Composition action identifier.
$pageNumber = 56; // Integer | Page number of the returned composition errors.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::CompositionsApi->new();
my $compositionId = 56; # Integer | Composition action identifier.
my $pageNumber = 56; # Integer | Page number of the returned composition errors.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETCompositionsCompositionIdErrors(compositionId => $compositionId, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompositionsApi->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.CompositionsApi()
compositionId = 56 # Integer | Composition action identifier.
pageNumber = 56 # Integer | Page number of the returned composition errors. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

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

Parameters

Path parameters
Name Description
compositionId*
Integer
Composition action identifier.
Required
Query parameters
Name Description
pageNumber*
Integer
Page number of the returned composition errors.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETPoolsPoolNameCompositions

Retrieves compositions.

Retrieves 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.CompositionsApi;

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

public class CompositionsApiExample {

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

        CompositionsApi apiInstance = new CompositionsApi();
        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 CompositionsApi#gETPoolsPoolNameCompositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompositionsApi;

public class CompositionsApiExample {

    public static void main(String[] args) {
        CompositionsApi apiInstance = new CompositionsApi();
        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 CompositionsApi#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

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

// Retrieves compositions.
[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.CompositionsApi()
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 CompositionsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves compositions.
                compositions result = apiInstance.gETPoolsPoolNameCompositions(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompositionsApi.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\ApiCompositionsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::CompositionsApi->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 CompositionsApi->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.CompositionsApi()
poolName = poolName_example # String | Name of the pool

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

Parameters

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

Responses

Status: 200 -


gETPoolsPoolNameCompositionsActionId

Retrieves a composition action.

Retrieves a 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.CompositionsApi;

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

public class CompositionsApiExample {

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

        CompositionsApi apiInstance = new CompositionsApi();
        Integer actionId = 56; // Integer | Action identifier 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 CompositionsApi#gETPoolsPoolNameCompositionsActionId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompositionsApi;

public class CompositionsApiExample {

    public static void main(String[] args) {
        CompositionsApi apiInstance = new CompositionsApi();
        Integer actionId = 56; // Integer | Action identifier 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 CompositionsApi#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; // Action identifier of the composition.
String *poolName = poolName_example; // Name of the pool

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

// Retrieves a composition action.
[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.CompositionsApi()
var actionId = 56; // {{Integer}} Action identifier 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 CompositionsApi();
            var actionId = 56;  // Integer | Action identifier of the composition.
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves a composition action.
                composition result = apiInstance.gETPoolsPoolNameCompositionsActionId(actionId, poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompositionsApi.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\ApiCompositionsApi();
$actionId = 56; // Integer | Action identifier 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 CompositionsApi->gETPoolsPoolNameCompositionsActionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CompositionsApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::CompositionsApi->new();
my $actionId = 56; # Integer | Action identifier 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 CompositionsApi->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.CompositionsApi()
actionId = 56 # Integer | Action identifier of the composition.
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves a composition action.
    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 CompositionsApi->gETPoolsPoolNameCompositionsActionId: %s\n" % e)

Parameters

Path parameters
Name Description
actionId*
Integer
Action identifier of the composition.
Required
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


pOSTPoolsPoolNameCompositions

Initiates a composition.

Initiates a composition (composes a raw item into a canonical item) 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.CompositionsApi;

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

public class CompositionsApiExample {

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

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

public class CompositionsApiExample {

    public static void main(String[] args) {
        CompositionsApi apiInstance = new CompositionsApi();
        String poolName = poolName_example; // String | Name of the pool
        Object body = ""; // Object | 
        try {
            composition result = apiInstance.pOSTPoolsPoolNameCompositions(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompositionsApi#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
Object *body = ""; //  (optional)

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

// Initiates a composition.
[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.CompositionsApi()
var poolName = poolName_example; // {{String}} Name of the pool
var opts = { 
  'body': "" // {{Object}} 
};
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 CompositionsApi();
            var poolName = poolName_example;  // String | Name of the pool
            var body = new Object(); // Object |  (optional) 

            try
            {
                // Initiates a composition.
                composition result = apiInstance.pOSTPoolsPoolNameCompositions(poolName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompositionsApi.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\ApiCompositionsApi();
$poolName = poolName_example; // String | Name of the pool
$body = ""; // Object | 

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

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

eval { 
    my $result = $api_instance->pOSTPoolsPoolNameCompositions(poolName => $poolName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompositionsApi->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.CompositionsApi()
poolName = poolName_example # String | Name of the pool
body = "" # Object |  (optional)

try: 
    # Initiates a composition.
    api_response = api_instance.p_ost_pools_pool_name_compositions(poolName, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompositionsApi->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

Status: 400 - Malformed syntax or bad query.


DataFeeds

dELETEDataFeedsFeedNameTypesItemType

Deletes canonical items.

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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

        DataFeedsApi apiInstance = new DataFeedsApi();
        String itemType = itemType_example; // String | Type of raw items created through the data feed that will be impacted.
        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 DataFeedsApi#dELETEDataFeedsFeedNameTypesItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFeedsApi;

public class DataFeedsApiExample {

    public static void main(String[] args) {
        DataFeedsApi apiInstance = new DataFeedsApi();
        String itemType = itemType_example; // String | Type of raw items created through the data feed that will be impacted.
        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 DataFeedsApi#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; // Type of raw items created through the data feed that will be impacted.
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.

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

// Deletes canonical items.
[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.DataFeedsApi()
var itemType = itemType_example; // {{String}} Type of raw items created through the data feed that will be impacted.
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 DataFeedsApi();
            var itemType = itemType_example;  // String | Type of raw items created through the data feed that will be impacted.
            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
            {
                // Deletes canonical items.
                result result = apiInstance.dELETEDataFeedsFeedNameTypesItemType(itemType, feedName, rawFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();
$itemType = itemType_example; // String | Type of raw items created through the data feed that will be impacted.
$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 DataFeedsApi->dELETEDataFeedsFeedNameTypesItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFeedsApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DataFeedsApi->new();
my $itemType = itemType_example; # String | Type of raw items created through the data feed that will be impacted.
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 DataFeedsApi->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.DataFeedsApi()
itemType = itemType_example # String | Type of raw items created through the data feed that will be impacted.
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: 
    # Deletes canonical items.
    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 DataFeedsApi->dELETEDataFeedsFeedNameTypesItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
Type of raw items created through the data feed that will be impacted.
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 -


gETDataFeeds

Retrieves data feeds.

Retrieves all data feeds that have been created in 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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

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

public class DataFeedsApiExample {

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

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

// Retrieves data feeds.
[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.DataFeedsApi()
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 DataFeedsApi();

            try
            {
                // Retrieves data feeds.
                data-feeds result = apiInstance.gETDataFeeds();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();

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

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

eval { 
    my $result = $api_instance->gETDataFeeds();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFeedsApi->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.DataFeedsApi()

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

Parameters

Responses

Status: 200 -


gETDataFeedsDataLoads

Retrieves data loading actions.

Retrieves 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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

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

public class DataFeedsApiExample {

    public static void main(String[] args) {
        DataFeedsApi apiInstance = new DataFeedsApi();
        String q = q_example; // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
        Integer pageNumber = 56; // Integer | Page number of the returned data loads.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            data-loads result = apiInstance.gETDataFeedsDataLoads(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFeedsApi#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; // Page number of the returned data loads. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves data loading actions.
[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.DataFeedsApi()
var q = q_example; // {{String}} Query string in lucene syntax.  Supported term is 'status' (0-many)
var pageNumber = 56; // {{Integer}} Page number of the returned data loads.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 DataFeedsApi();
            var q = q_example;  // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
            var pageNumber = 56;  // Integer | Page number of the returned data loads. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves data loading actions.
                data-loads result = apiInstance.gETDataFeedsDataLoads(q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();
$q = q_example; // String | Query string in lucene syntax.  Supported term is 'status' (0-many)
$pageNumber = 56; // Integer | Page number of the returned data loads.
$pageSize = 56; // Integer | Number of results returned per page.

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

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

eval { 
    my $result = $api_instance->gETDataFeedsDataLoads(q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFeedsApi->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.DataFeedsApi()
q = q_example # String | Query string in lucene syntax.  Supported term is 'status' (0-many)
pageNumber = 56 # Integer | Page number of the returned data loads. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves data loading actions.
    api_response = api_instance.g_et_data_feeds_data_loads(q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFeedsApi->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
Page number of the returned data loads.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETDataFeedsFeedName

Retrieves data feed information.

Retrieves information about one data feed.


/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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

        DataFeedsApi apiInstance = new DataFeedsApi();
        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 DataFeedsApi#gETDataFeedsFeedName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFeedsApi;

public class DataFeedsApiExample {

    public static void main(String[] args) {
        DataFeedsApi apiInstance = new DataFeedsApi();
        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 DataFeedsApi#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

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

// Retrieves data feed information.
[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.DataFeedsApi()
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 DataFeedsApi();
            var feedName = feedName_example;  // String | Name of the data feed

            try
            {
                // Retrieves data feed information.
                data-feed result = apiInstance.gETDataFeedsFeedName(feedName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();
$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 DataFeedsApi->gETDataFeedsFeedName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataFeedsApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DataFeedsApi->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 DataFeedsApi->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.DataFeedsApi()
feedName = feedName_example # String | Name of the data feed

try: 
    # Retrieves data feed information.
    api_response = api_instance.g_et_data_feeds_feed_name(feedName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFeedsApi->gETDataFeedsFeedName: %s\n" % e)

Parameters

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

Responses

Status: 200 -


gETDataFeedsFeedNamePools

Retrieves relevant pools.

Retrieves 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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

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

public class DataFeedsApiExample {

    public static void main(String[] args) {
        DataFeedsApi apiInstance = new DataFeedsApi();
        String feedName = feedName_example; // String | Name of the data feed
        Integer pageNumber = 56; // Integer | Page number of the returned data loads.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            pools result = apiInstance.gETDataFeedsFeedNamePools(feedName, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFeedsApi#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; // Page number of the returned data loads. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves relevant pools.
[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.DataFeedsApi()
var feedName = feedName_example; // {{String}} Name of the data feed
var pageNumber = 56; // {{Integer}} Page number of the returned data loads.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 DataFeedsApi();
            var feedName = feedName_example;  // String | Name of the data feed
            var pageNumber = 56;  // Integer | Page number of the returned data loads. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves relevant pools.
                pools result = apiInstance.gETDataFeedsFeedNamePools(feedName, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();
$feedName = feedName_example; // String | Name of the data feed
$pageNumber = 56; // Integer | Page number of the returned data loads.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::DataFeedsApi->new();
my $feedName = feedName_example; # String | Name of the data feed
my $pageNumber = 56; # Integer | Page number of the returned data loads.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETDataFeedsFeedNamePools(feedName => $feedName, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFeedsApi->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.DataFeedsApi()
feedName = feedName_example # String | Name of the data feed
pageNumber = 56 # Integer | Page number of the returned data loads. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves relevant pools.
    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 DataFeedsApi->gETDataFeedsFeedNamePools: %s\n" % e)

Parameters

Path parameters
Name Description
feedName*
String
Name of the data feed
Required
Query parameters
Name Description
pageNumber*
Integer
Page number of the returned data loads.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


pOSTDataFeeds

Creates a data feed.

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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

        DataFeedsApi apiInstance = new DataFeedsApi();
        Data-feed body = "{ \"name\": \"TEST_DATA_FEED\", \"poolingCondition\": \"SMOKE_TEST_POOL\", \"poolingStrategy\": \"NAMED_POOL\" }"; // Data-feed | 
        try {
            data-feed result = apiInstance.pOSTDataFeeds(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFeedsApi#pOSTDataFeeds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFeedsApi;

public class DataFeedsApiExample {

    public static void main(String[] args) {
        DataFeedsApi apiInstance = new DataFeedsApi();
        Data-feed body = "{ \"name\": \"TEST_DATA_FEED\", \"poolingCondition\": \"SMOKE_TEST_POOL\", \"poolingStrategy\": \"NAMED_POOL\" }"; // Data-feed | 
        try {
            data-feed result = apiInstance.pOSTDataFeeds(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFeedsApi#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 = "{ \"name\": \"TEST_DATA_FEED\", \"poolingCondition\": \"SMOKE_TEST_POOL\", \"poolingStrategy\": \"NAMED_POOL\" }"; //  (optional)

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

// Creates a data feed.
[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.DataFeedsApi()
var opts = { 
  'body': "{ \"name\": \"TEST_DATA_FEED\", \"poolingCondition\": \"SMOKE_TEST_POOL\", \"poolingStrategy\": \"NAMED_POOL\" }" // {{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 DataFeedsApi();
            var body = new Data-feed(); // Data-feed |  (optional) 

            try
            {
                // Creates a data feed.
                data-feed result = apiInstance.pOSTDataFeeds(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();
$body = "{ \"name\": \"TEST_DATA_FEED\", \"poolingCondition\": \"SMOKE_TEST_POOL\", \"poolingStrategy\": \"NAMED_POOL\" }"; // Data-feed | 

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

my $api_instance = WWW::SwaggerClient::DataFeedsApi->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 DataFeedsApi->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.DataFeedsApi()
body = "{ \"name\": \"TEST_DATA_FEED\", \"poolingCondition\": \"SMOKE_TEST_POOL\", \"poolingStrategy\": \"NAMED_POOL\" }" # Data-feed |  (optional)

try: 
    # Creates a data feed.
    api_response = api_instance.p_ost_data_feeds(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFeedsApi->pOSTDataFeeds: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String

Status: 400 - Malformed syntax or bad query.


pOSTDataFeedsFeedNamePools

Creates a pool.

Creates a new pool for the given data feed name.


/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.DataFeedsApi;

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

public class DataFeedsApiExample {

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

        DataFeedsApi apiInstance = new DataFeedsApi();
        String feedName = feedName_example; // String | Name of the data feed
        Pool body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\", \"deletable\": true }"; // Pool | 
        try {
            pool result = apiInstance.pOSTDataFeedsFeedNamePools(feedName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFeedsApi#pOSTDataFeedsFeedNamePools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFeedsApi;

public class DataFeedsApiExample {

    public static void main(String[] args) {
        DataFeedsApi apiInstance = new DataFeedsApi();
        String feedName = feedName_example; // String | Name of the data feed
        Pool body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\", \"deletable\": true }"; // Pool | 
        try {
            pool result = apiInstance.pOSTDataFeedsFeedNamePools(feedName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFeedsApi#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 = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\", \"deletable\": true }"; //  (optional)

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

// Creates a pool.
[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.DataFeedsApi()
var feedName = feedName_example; // {{String}} Name of the data feed
var opts = { 
  'body': "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\", \"deletable\": true }" // {{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 DataFeedsApi();
            var feedName = feedName_example;  // String | Name of the data feed
            var body = new Pool(); // Pool |  (optional) 

            try
            {
                // Creates a pool.
                pool result = apiInstance.pOSTDataFeedsFeedNamePools(feedName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFeedsApi.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\ApiDataFeedsApi();
$feedName = feedName_example; // String | Name of the data feed
$body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\", \"deletable\": true }"; // Pool | 

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

my $api_instance = WWW::SwaggerClient::DataFeedsApi->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 DataFeedsApi->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.DataFeedsApi()
feedName = feedName_example # String | Name of the data feed
body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\", \"deletable\": true }" # Pool |  (optional)

try: 
    # Creates a pool.
    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 DataFeedsApi->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

Status: 400 - Malformed syntax or bad query.


Extensions

pOSTExtensions

Creates a Data Hub extension.

Creates a new Data Hub extension based on the XML provided in the body. The XML should conform to datahub-metadata-schema-1.6.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.ExtensionsApi;

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

public class ExtensionsApiExample {

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

        ExtensionsApi apiInstance = new ExtensionsApi();
        String body = "   TestCanonicalCustomer   id  String true    name  String      "; // String | 
        try {
            apiInstance.pOSTExtensions(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtensionsApi#pOSTExtensions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExtensionsApi;

public class ExtensionsApiExample {

    public static void main(String[] args) {
        ExtensionsApi apiInstance = new ExtensionsApi();
        String body = "   TestCanonicalCustomer   id  String true    name  String      "; // String | 
        try {
            apiInstance.pOSTExtensions(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExtensionsApi#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 = "   TestCanonicalCustomer   id  String true    name  String      "; //  (optional)

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

// Creates a Data Hub extension.
[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.ExtensionsApi()
var opts = { 
  'body': "   TestCanonicalCustomer   id  String true    name  String      " // {{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 ExtensionsApi();
            var body = new String(); // String |  (optional) 

            try
            {
                // Creates a Data Hub extension.
                apiInstance.pOSTExtensions(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExtensionsApi.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\ApiExtensionsApi();
$body = "   TestCanonicalCustomer   id  String true    name  String      "; // String | 

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

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

eval { 
    $api_instance->pOSTExtensions(body => $body);
};
if ($@) {
    warn "Exception when calling ExtensionsApi->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.ExtensionsApi()
body = "   TestCanonicalCustomer   id  String true    name  String      " # String |  (optional)

try: 
    # Creates a Data Hub extension.
    api_instance.p_ost_extensions(body=body)
except ApiException as e:
    print("Exception when calling ExtensionsApi->pOSTExtensions: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Creates a Data Hub extension for the given data feed name.

Status: 400 - Extension was not created, XML was invalid


ItemClasses

gETItemClasses

Retrieves item classes.

Retrieves 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

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

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

// Retrieves item classes.
[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.ItemClassesApi()
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 ItemClassesApi();

            try
            {
                // Retrieves item classes.
                item-classes result = apiInstance.gETItemClasses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();

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

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

eval { 
    my $result = $api_instance->gETItemClasses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()

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

Parameters

Responses

Status: 200 -


gETItemClassesCanonicalItemTypes

Retrieves canonical item types.

Retrieves 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

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

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

// Retrieves canonical item types.
[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.ItemClassesApi()
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 ItemClassesApi();

            try
            {
                // Retrieves canonical item types.
                item-types result = apiInstance.gETItemClassesCanonicalItemTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();

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

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

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()

try: 
    # Retrieves canonical item types.
    api_response = api_instance.g_et_item_classes_canonical_item_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemClassesApi->gETItemClassesCanonicalItemTypes: %s\n" % e)

Parameters

Responses

Status: 200 -


gETItemClassesCanonicalItemTypesItemTypeAttributes

Retrieves canonical item attributes.

Retrieves attributes for a canonical 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

    public static void main(String[] args) {
        ItemClassesApi apiInstance = new ItemClassesApi();
        String itemType = itemType_example; // String | Type of canonical item to be retrieved.
        try {
            canonical-attribute-definitions result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemClassesApi#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; // Type of canonical item to be retrieved.

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

// Retrieves canonical item attributes.
[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.ItemClassesApi()
var itemType = itemType_example; // {{String}} Type of canonical item to be retrieved.

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 ItemClassesApi();
            var itemType = itemType_example;  // String | Type of canonical item to be retrieved.

            try
            {
                // Retrieves canonical item attributes.
                canonical-attribute-definitions result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();
$itemType = itemType_example; // String | Type of canonical item to be retrieved.

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

my $api_instance = WWW::SwaggerClient::ItemClassesApi->new();
my $itemType = itemType_example; # String | Type of canonical item to be retrieved.

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypesItemTypeAttributes(itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()
itemType = itemType_example # String | Type of canonical item to be retrieved.

try: 
    # Retrieves canonical item attributes.
    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 ItemClassesApi->gETItemClassesCanonicalItemTypesItemTypeAttributes: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
Type of canonical item to be retrieved.
Required

Responses

Status: 200 -


gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName

Retrieves a canonical item attribute.

Retrieves a canonical item attribute according to the specified item type and 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

    public static void main(String[] args) {
        ItemClassesApi apiInstance = new ItemClassesApi();
        String attributeName = attributeName_example; // String | Name of the canonical item attribute
        String itemType = itemType_example; // String | Type of canonical item to be retrieved.
        try {
            canonical-attribute-definition result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemClassesApi#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; // Type of canonical item to be retrieved.

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

// Retrieves a canonical item attribute.
[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.ItemClassesApi()
var attributeName = attributeName_example; // {{String}} Name of the canonical item attribute
var itemType = itemType_example; // {{String}} Type of canonical item to be retrieved.

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 ItemClassesApi();
            var attributeName = attributeName_example;  // String | Name of the canonical item attribute
            var itemType = itemType_example;  // String | Type of canonical item to be retrieved.

            try
            {
                // Retrieves a canonical item attribute.
                canonical-attribute-definition result = apiInstance.gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();
$attributeName = attributeName_example; // String | Name of the canonical item attribute
$itemType = itemType_example; // String | Type of canonical item to be retrieved.

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

my $api_instance = WWW::SwaggerClient::ItemClassesApi->new();
my $attributeName = attributeName_example; # String | Name of the canonical item attribute
my $itemType = itemType_example; # String | Type of canonical item to be retrieved.

eval { 
    my $result = $api_instance->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName(attributeName => $attributeName, itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()
attributeName = attributeName_example # String | Name of the canonical item attribute
itemType = itemType_example # String | Type of canonical item to be retrieved.

try: 
    # Retrieves a canonical item attribute.
    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 ItemClassesApi->gETItemClassesCanonicalItemTypesItemTypeAttributesAttributeName: %s\n" % e)

Parameters

Path parameters
Name Description
attributeName*
String
Name of the canonical item attribute
Required
itemType*
String
Type of canonical item to be retrieved.
Required

Responses

Status: 200 -


gETItemClassesRawItemTypes

Retrieves raw item types.

Retrieves 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

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

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

// Retrieves raw item types.
[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.ItemClassesApi()
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 ItemClassesApi();

            try
            {
                // Retrieves raw item types.
                item-types result = apiInstance.gETItemClassesRawItemTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();

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

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

eval { 
    my $result = $api_instance->gETItemClassesRawItemTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()

try: 
    # Retrieves raw item types.
    api_response = api_instance.g_et_item_classes_raw_item_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemClassesApi->gETItemClassesRawItemTypes: %s\n" % e)

Parameters

Responses

Status: 200 -


gETItemClassesRawItemTypesItemTypeAttributes

Retrieves raw item attributes.

Retrieves attributes for an raw 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

    public static void main(String[] args) {
        ItemClassesApi apiInstance = new ItemClassesApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        try {
            raw-attribute-definitions result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributes(itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemClassesApi#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; // Type of item to be retrieved.

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

// Retrieves raw item attributes.
[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.ItemClassesApi()
var itemType = itemType_example; // {{String}} Type of item to be retrieved.

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 ItemClassesApi();
            var itemType = itemType_example;  // String | Type of item to be retrieved.

            try
            {
                // Retrieves raw item attributes.
                raw-attribute-definitions result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributes(itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();
$itemType = itemType_example; // String | Type of item to be retrieved.

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

my $api_instance = WWW::SwaggerClient::ItemClassesApi->new();
my $itemType = itemType_example; # String | Type of item to be retrieved.

eval { 
    my $result = $api_instance->gETItemClassesRawItemTypesItemTypeAttributes(itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()
itemType = itemType_example # String | Type of item to be retrieved.

try: 
    # Retrieves raw item attributes.
    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 ItemClassesApi->gETItemClassesRawItemTypesItemTypeAttributes: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
Type of item to be retrieved.
Required

Responses

Status: 200 -


gETItemClassesRawItemTypesItemTypeAttributesAttributeName

Retrieves raw item attribute.

Retrieves 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.ItemClassesApi;

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

public class ItemClassesApiExample {

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

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

public class ItemClassesApiExample {

    public static void main(String[] args) {
        ItemClassesApi apiInstance = new ItemClassesApi();
        String attributeName = attributeName_example; // String | Name of the raw item attribute.
        String itemType = itemType_example; // String | Type of item to be retrieved.
        try {
            raw-attribute-definition result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemClassesApi#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; // Type of item to be retrieved.

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

// Retrieves raw item attribute.
[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.ItemClassesApi()
var attributeName = attributeName_example; // {{String}} Name of the raw item attribute.
var itemType = itemType_example; // {{String}} Type of item to be retrieved.

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 ItemClassesApi();
            var attributeName = attributeName_example;  // String | Name of the raw item attribute.
            var itemType = itemType_example;  // String | Type of item to be retrieved.

            try
            {
                // Retrieves raw item attribute.
                raw-attribute-definition result = apiInstance.gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName, itemType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemClassesApi.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\ApiItemClassesApi();
$attributeName = attributeName_example; // String | Name of the raw item attribute.
$itemType = itemType_example; // String | Type of item to be retrieved.

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

my $api_instance = WWW::SwaggerClient::ItemClassesApi->new();
my $attributeName = attributeName_example; # String | Name of the raw item attribute.
my $itemType = itemType_example; # String | Type of item to be retrieved.

eval { 
    my $result = $api_instance->gETItemClassesRawItemTypesItemTypeAttributesAttributeName(attributeName => $attributeName, itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemClassesApi->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.ItemClassesApi()
attributeName = attributeName_example # String | Name of the raw item attribute.
itemType = itemType_example # String | Type of item to be retrieved.

try: 
    # Retrieves raw item attribute.
    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 ItemClassesApi->gETItemClassesRawItemTypesItemTypeAttributesAttributeName: %s\n" % e)

Parameters

Path parameters
Name Description
attributeName*
String
Name of the raw item attribute.
Required
itemType*
String
Type of item to be retrieved.
Required

Responses

Status: 200 -


Pools

dELETEPoolsPoolNameItemsItemType

Deletes canonical items.

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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        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 PoolsApi#dELETEPoolsPoolNameItemsItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        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 PoolsApi#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; // Type of item to be retrieved.
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

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

// Deletes canonical items.
[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.PoolsApi()
var itemType = itemType_example; // {{String}} Type of item to be retrieved.
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 PoolsApi();
            var itemType = itemType_example;  // String | Type of item to be retrieved.
            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
            {
                // Deletes canonical items.
                result result = apiInstance.dELETEPoolsPoolNameItemsItemType(itemType, poolName, keyFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$itemType = itemType_example; // String | Type of item to be retrieved.
$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 PoolsApi->dELETEPoolsPoolNameItemsItemType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $itemType = itemType_example; # String | Type of item to be retrieved.
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 PoolsApi->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.PoolsApi()
itemType = itemType_example # String | Type of item to be retrieved.
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: 
    # Deletes canonical items.
    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 PoolsApi->dELETEPoolsPoolNameItemsItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
Type of item to be retrieved.
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 -


gETPools

Retrieves pools.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        Integer pageNumber = 56; // Integer | Page number of the returned data loads.
        Integer pageSize = 56; // Integer | Number of results returned per page."
        try {
            pools result = apiInstance.gETPools(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#gETPools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        Integer pageNumber = 56; // Integer | Page number of the returned data loads.
        Integer pageSize = 56; // Integer | Number of results returned per page."
        try {
            pools result = apiInstance.gETPools(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#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; // Page number of the returned data loads. (default to 0)
Integer *pageSize = 56; // Number of results returned per page." (default to 50)

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

// Retrieves pools.
[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.PoolsApi()
var pageNumber = 56; // {{Integer}} Page number of the returned data loads.
var pageSize = 56; // {{Integer}} Number of results returned per page."

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 PoolsApi();
            var pageNumber = 56;  // Integer | Page number of the returned data loads. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page." (default to 50)

            try
            {
                // Retrieves pools.
                pools result = apiInstance.gETPools(pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$pageNumber = 56; // Integer | Page number of the returned data loads.
$pageSize = 56; // Integer | Number of results returned per page."

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

my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $pageNumber = 56; # Integer | Page number of the returned data loads.
my $pageSize = 56; # Integer | Number of results returned per page."

eval { 
    my $result = $api_instance->gETPools(pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->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.PoolsApi()
pageNumber = 56 # Integer | Page number of the returned data loads. (default to 0)
pageSize = 56 # Integer | Number of results returned per page." (default to 50)

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

Parameters

Query parameters
Name Description
pageNumber*
Integer
Page number of the returned data loads.
Required
pageSize*
Integer
Number of results returned per page."
Required

Responses

Status: 200 -


gETPoolsPoolName

Retrieves pool information.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#gETPoolsPoolName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#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

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

// Retrieves pool information.
[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.PoolsApi()
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 PoolsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves pool information.
                pool result = apiInstance.gETPoolsPoolName(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
poolName = poolName_example # String | Name of the pool

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

Parameters

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

Responses

Status: 200 -


gETPoolsPoolNameItemsItemType

Retrieves items by type and pool name.

Retrieves 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}?keyFields=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        String poolName = poolName_example; // String | Name of the pool
        String keyFields = keyFields_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 | Page number of the returned items.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            data-items result = apiInstance.gETPoolsPoolNameItemsItemType(itemType, poolName, keyFields, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#gETPoolsPoolNameItemsItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        String poolName = poolName_example; // String | Name of the pool
        String keyFields = keyFields_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 | Page number of the returned items.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            data-items result = apiInstance.gETPoolsPoolNameItemsItemType(itemType, poolName, keyFields, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#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; // Type of item to be retrieved.
String *poolName = poolName_example; // Name of the pool
String *keyFields = keyFields_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; // Page number of the returned items. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves items by type and pool name.
[apiInstance gETPoolsPoolNameItemsItemTypeWith:itemType
    poolName:poolName
    keyFields:keyFields
    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.PoolsApi()
var itemType = itemType_example; // {{String}} Type of item to be retrieved.
var poolName = poolName_example; // {{String}} Name of the pool
var keyFields = keyFields_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}} Page number of the returned items.
var pageSize = 56; // {{Integer}} Number of results returned per page.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gETPoolsPoolNameItemsItemType(itemType, poolName, keyFields, 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 PoolsApi();
            var itemType = itemType_example;  // String | Type of item to be retrieved.
            var poolName = poolName_example;  // String | Name of the pool
            var keyFields = keyFields_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 | Page number of the returned items. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves items by type and pool name.
                data-items result = apiInstance.gETPoolsPoolNameItemsItemType(itemType, poolName, keyFields, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$itemType = itemType_example; // String | Type of item to be retrieved.
$poolName = poolName_example; // String | Name of the pool
$keyFields = keyFields_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 | Page number of the returned items.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $itemType = itemType_example; # String | Type of item to be retrieved.
my $poolName = poolName_example; # String | Name of the pool
my $keyFields = keyFields_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 | Page number of the returned items.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETPoolsPoolNameItemsItemType(itemType => $itemType, poolName => $poolName, keyFields => $keyFields, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->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.PoolsApi()
itemType = itemType_example # String | Type of item to be retrieved.
poolName = poolName_example # String | Name of the pool
keyFields = keyFields_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 | Page number of the returned items. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves items by type and pool name.
    api_response = api_instance.g_et_pools_pool_name_items_item_type(itemType, poolName, keyFields, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->gETPoolsPoolNameItemsItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
Type of item to be retrieved.
Required
poolName*
String
Name of the pool
Required
Query parameters
Name Description
keyFields*
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
Page number of the returned items.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETPoolsPoolNamePoolHistory

Retrieves all actions.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#gETPoolsPoolNamePoolHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#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

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

// Retrieves all actions.
[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.PoolsApi()
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 PoolsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves all actions.
                pool-actions result = apiInstance.gETPoolsPoolNamePoolHistory(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
poolName = poolName_example # String | Name of the pool

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

Parameters

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

Responses

Status: 200 -


gETPoolsPoolNameStatusCounts

Retrieves all status counts for item types.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#gETPoolsPoolNameStatusCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#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

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

// Retrieves all status counts for item types.
[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.PoolsApi()
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 PoolsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves all status counts for item types.
                item-status-counts result = apiInstance.gETPoolsPoolNameStatusCounts(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves all status counts for item types.
    api_response = api_instance.g_et_pools_pool_name_status_counts(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->gETPoolsPoolNameStatusCounts: %s\n" % e)

Parameters

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

Responses

Status: 200 -


gETPoolsPoolNameStatusCountsCanonical

Retrieves all status counts for canonical items.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#gETPoolsPoolNameStatusCountsCanonical");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#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

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

// Retrieves all status counts for canonical items.
[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.PoolsApi()
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 PoolsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves all status counts for canonical items.
                canonical-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonical(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves all status counts for canonical items.
    api_response = api_instance.g_et_pools_pool_name_status_counts_canonical(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->gETPoolsPoolNameStatusCountsCanonical: %s\n" % e)

Parameters

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

Responses

Status: 200 -


gETPoolsPoolNameStatusCountsCanonicalPublication

Retrieves all status counts for canonical publication items.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#gETPoolsPoolNameStatusCountsCanonicalPublication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#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

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

// Retrieves all status counts for canonical publication items.
[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.PoolsApi()
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 PoolsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves all status counts for canonical publication items.
                canonical-publication-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsCanonicalPublication(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves all status counts for canonical publication items.
    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 PoolsApi->gETPoolsPoolNameStatusCountsCanonicalPublication: %s\n" % e)

Parameters

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

Responses

Status: 200 -


gETPoolsPoolNameStatusCountsRaw

Retrieves all status counts for raw items.

Retrieves 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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#gETPoolsPoolNameStatusCountsRaw");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        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 PoolsApi#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

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

// Retrieves all status counts for raw items.
[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.PoolsApi()
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 PoolsApi();
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves all status counts for raw items.
                raw-item-status-counts result = apiInstance.gETPoolsPoolNameStatusCountsRaw(poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$poolName = poolName_example; // String | Name of the pool

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves all status counts for raw items.
    api_response = api_instance.g_et_pools_pool_name_status_counts_raw(poolName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->gETPoolsPoolNameStatusCountsRaw: %s\n" % e)

Parameters

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

Responses

Status: 200 -


pOSTPools

Creates a pool.

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.PoolsApi;

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

public class PoolsApiExample {

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

        PoolsApi apiInstance = new PoolsApi();
        Pool body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\" }"; // Pool | 
        try {
            pool result = apiInstance.pOSTPools(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#pOSTPools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        Pool body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\" }"; // Pool | 
        try {
            pool result = apiInstance.pOSTPools(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#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 = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\" }"; //  (optional)

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

// Creates a pool.
[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.PoolsApi()
var opts = { 
  'body': "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\" }" // {{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 PoolsApi();
            var body = new Pool(); // Pool |  (optional) 

            try
            {
                // Creates a pool.
                pool result = apiInstance.pOSTPools(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.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\ApiPoolsApi();
$body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\" }"; // Pool | 

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

my $api_instance = WWW::SwaggerClient::PoolsApi->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 PoolsApi->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.PoolsApi()
body = "{ \"poolName\": \"SMOKE_TEST_POOL\", \"compositionStrategy\": \"MANUAL\", \"publicationStrategy\": \"MANUAL\" }" # Pool |  (optional)

try: 
    # Creates a pool.
    api_response = api_instance.p_ost_pools(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->pOSTPools: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 -

Name Type Format Description
Location String

Status: 400 - Malformed syntax or bad query.


Publications

gETPoolsPoolNamePublications

Retrieves a page of publications.

Retrieves a page of publications by pool name.


/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.PublicationsApi;

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

public class PublicationsApiExample {

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

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

public class PublicationsApiExample {

    public static void main(String[] args) {
        PublicationsApi apiInstance = new PublicationsApi();
        String poolName = poolName_example; // String | Name of the pool
        Integer pageNumber = 56; // Integer | Page number of the returned publications.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            publications result = apiInstance.gETPoolsPoolNamePublications(poolName, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicationsApi#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; // Page number of the returned publications. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves a page of publications.
[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.PublicationsApi()
var poolName = poolName_example; // {{String}} Name of the pool
var pageNumber = 56; // {{Integer}} Page number of the returned publications.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 PublicationsApi();
            var poolName = poolName_example;  // String | Name of the pool
            var pageNumber = 56;  // Integer | Page number of the returned publications. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves a page of publications.
                publications result = apiInstance.gETPoolsPoolNamePublications(poolName, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicationsApi.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\ApiPublicationsApi();
$poolName = poolName_example; // String | Name of the pool
$pageNumber = 56; // Integer | Page number of the returned publications.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::PublicationsApi->new();
my $poolName = poolName_example; # String | Name of the pool
my $pageNumber = 56; # Integer | Page number of the returned publications.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETPoolsPoolNamePublications(poolName => $poolName, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicationsApi->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.PublicationsApi()
poolName = poolName_example # String | Name of the pool
pageNumber = 56 # Integer | Page number of the returned publications. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves a page of publications.
    api_response = api_instance.g_et_pools_pool_name_publications(poolName, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicationsApi->gETPoolsPoolNamePublications: %s\n" % e)

Parameters

Path parameters
Name Description
poolName*
String
Name of the pool
Required
Query parameters
Name Description
pageNumber*
Integer
Page number of the returned publications.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETPoolsPoolNamePublicationsActionId

Retrieves a publication action.

Retrieves a 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.PublicationsApi;

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

public class PublicationsApiExample {

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

        PublicationsApi apiInstance = new PublicationsApi();
        Integer actionId = 56; // Integer | Action identifier 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 PublicationsApi#gETPoolsPoolNamePublicationsActionId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicationsApi;

public class PublicationsApiExample {

    public static void main(String[] args) {
        PublicationsApi apiInstance = new PublicationsApi();
        Integer actionId = 56; // Integer | Action identifier 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 PublicationsApi#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; // Action identifier of the publication.
String *poolName = poolName_example; // Name of the pool

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

// Retrieves a publication action.
[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.PublicationsApi()
var actionId = 56; // {{Integer}} Action identifier 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 PublicationsApi();
            var actionId = 56;  // Integer | Action identifier of the publication.
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves a publication action.
                publication result = apiInstance.gETPoolsPoolNamePublicationsActionId(actionId, poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicationsApi.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\ApiPublicationsApi();
$actionId = 56; // Integer | Action identifier 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 PublicationsApi->gETPoolsPoolNamePublicationsActionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PublicationsApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::PublicationsApi->new();
my $actionId = 56; # Integer | Action identifier 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 PublicationsApi->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.PublicationsApi()
actionId = 56 # Integer | Action identifier of the publication.
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves a publication action.
    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 PublicationsApi->gETPoolsPoolNamePublicationsActionId: %s\n" % e)

Parameters

Path parameters
Name Description
actionId*
Integer
Action identifier of the publication.
Required
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


gETPoolsPoolNamePublicationsActionIdTargetSystemPublications

Retrieves target system publications.

Retrieves 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.PublicationsApi;

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

public class PublicationsApiExample {

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

        PublicationsApi apiInstance = new PublicationsApi();
        Integer actionId = 56; // Integer | Action identifier 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 PublicationsApi#gETPoolsPoolNamePublicationsActionIdTargetSystemPublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicationsApi;

public class PublicationsApiExample {

    public static void main(String[] args) {
        PublicationsApi apiInstance = new PublicationsApi();
        Integer actionId = 56; // Integer | Action identifier 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 PublicationsApi#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; // Action identifier of the publication.
String *poolName = poolName_example; // Name of the pool

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

// Retrieves target system publications.
[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.PublicationsApi()
var actionId = 56; // {{Integer}} Action identifier 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 PublicationsApi();
            var actionId = 56;  // Integer | Action identifier of the publication.
            var poolName = poolName_example;  // String | Name of the pool

            try
            {
                // Retrieves target system publications.
                target-system-publications result = apiInstance.gETPoolsPoolNamePublicationsActionIdTargetSystemPublications(actionId, poolName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicationsApi.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\ApiPublicationsApi();
$actionId = 56; // Integer | Action identifier 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 PublicationsApi->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PublicationsApi;
# Configure HTTP basic authorization: Basic_Authentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::PublicationsApi->new();
my $actionId = 56; # Integer | Action identifier 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 PublicationsApi->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.PublicationsApi()
actionId = 56 # Integer | Action identifier of the publication.
poolName = poolName_example # String | Name of the pool

try: 
    # Retrieves target system publications.
    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 PublicationsApi->gETPoolsPoolNamePublicationsActionIdTargetSystemPublications: %s\n" % e)

Parameters

Path parameters
Name Description
actionId*
Integer
Action identifier of the publication.
Required
poolName*
String
Name of the pool
Required

Responses

Status: 200 -


pOSTPoolsPoolNamePublications

Initiates a publication.

Initiates a publication (publishes a canonical item to a target system) 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.PublicationsApi;

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

public class PublicationsApiExample {

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

        PublicationsApi apiInstance = new PublicationsApi();
        String poolName = poolName_example; // String | Name of the pool
        array[target-system] body = "{ \"targetSystemPublications\": [ { \"targetSystemName\": \"HybrisCore\" } ] }"; // array[target-system] | 
        try {
            publication result = apiInstance.pOSTPoolsPoolNamePublications(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicationsApi#pOSTPoolsPoolNamePublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicationsApi;

public class PublicationsApiExample {

    public static void main(String[] args) {
        PublicationsApi apiInstance = new PublicationsApi();
        String poolName = poolName_example; // String | Name of the pool
        array[target-system] body = "{ \"targetSystemPublications\": [ { \"targetSystemName\": \"HybrisCore\" } ] }"; // array[target-system] | 
        try {
            publication result = apiInstance.pOSTPoolsPoolNamePublications(poolName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicationsApi#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
array[target-system] *body = "{ \"targetSystemPublications\": [ { \"targetSystemName\": \"HybrisCore\" } ] }"; //  (optional)

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

// Initiates a publication.
[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.PublicationsApi()
var poolName = poolName_example; // {{String}} Name of the pool
var opts = { 
  'body': "{ \"targetSystemPublications\": [ { \"targetSystemName\": \"HybrisCore\" } ] }" // {{array[target-system]}} 
};
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 PublicationsApi();
            var poolName = poolName_example;  // String | Name of the pool
            var body = new array[target-system](); // array[target-system] |  (optional) 

            try
            {
                // Initiates a publication.
                publication result = apiInstance.pOSTPoolsPoolNamePublications(poolName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicationsApi.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\ApiPublicationsApi();
$poolName = poolName_example; // String | Name of the pool
$body = "{ \"targetSystemPublications\": [ { \"targetSystemName\": \"HybrisCore\" } ] }"; // array[target-system] | 

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

my $api_instance = WWW::SwaggerClient::PublicationsApi->new();
my $poolName = poolName_example; # String | Name of the pool
my $body = [WWW::SwaggerClient::Object::array[target-system]->new()]; # array[target-system] | 

eval { 
    my $result = $api_instance->pOSTPoolsPoolNamePublications(poolName => $poolName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicationsApi->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.PublicationsApi()
poolName = poolName_example # String | Name of the pool
body = "{ \"targetSystemPublications\": [ { \"targetSystemName\": \"HybrisCore\" } ] }" # array[target-system] |  (optional)

try: 
    # Initiates a publication.
    api_response = api_instance.p_ost_pools_pool_name_publications(poolName, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicationsApi->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

Status: 400 - Malformed syntax or bad query.


RawItems

gETRawItemsItemId

Retrieves a raw item.

Retrieves the specified raw item.


/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.RawItemsApi;

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

public class RawItemsApiExample {

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

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

public class RawItemsApiExample {

    public static void main(String[] args) {
        RawItemsApi apiInstance = new RawItemsApi();
        Integer itemId = 56; // Integer | Raw item identifier.
        try {
            data-item result = apiInstance.gETRawItemsItemId(itemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RawItemsApi#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; // Raw item identifier.

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

// Retrieves a raw item.
[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.RawItemsApi()
var itemId = 56; // {{Integer}} Raw item identifier.

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 RawItemsApi();
            var itemId = 56;  // Integer | Raw item identifier.

            try
            {
                // Retrieves a raw item.
                data-item result = apiInstance.gETRawItemsItemId(itemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RawItemsApi.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\ApiRawItemsApi();
$itemId = 56; // Integer | Raw item identifier.

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

my $api_instance = WWW::SwaggerClient::RawItemsApi->new();
my $itemId = 56; # Integer | Raw item identifier.

eval { 
    my $result = $api_instance->gETRawItemsItemId(itemId => $itemId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RawItemsApi->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.RawItemsApi()
itemId = 56 # Integer | Raw item identifier.

try: 
    # Retrieves a raw item.
    api_response = api_instance.g_et_raw_items_item_id(itemId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RawItemsApi->gETRawItemsItemId: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
Integer
Raw item identifier.
Required

Responses

Status: 200 -


Status

gETStatus

Retrieves the status.

Retrieves the current state of 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.StatusApi;

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

public class StatusApiExample {

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

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

public class StatusApiExample {

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

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

// Retrieves the status.
[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.StatusApi()
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 StatusApi();

            try
            {
                // Retrieves the status.
                apiInstance.gETStatus();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusApi.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\ApiStatusApi();

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

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

eval { 
    $api_instance->gETStatus();
};
if ($@) {
    warn "Exception when calling StatusApi->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.StatusApi()

try: 
    # Retrieves the status.
    api_instance.g_et_status()
except ApiException as e:
    print("Exception when calling StatusApi->gETStatus: %s\n" % e)

Parameters

Responses

Status: 200 -


StatusCounts

gETStatusCounts

Retrieves all status counts for all item types.

Adds status counts for all pools 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.StatusCountsApi;

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

public class StatusCountsApiExample {

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

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

public class StatusCountsApiExample {

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

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

// Retrieves all status counts for all item types.
[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.StatusCountsApi()
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 StatusCountsApi();

            try
            {
                // Retrieves all status counts for all item types.
                item-status-counts result = apiInstance.gETStatusCounts();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusCountsApi.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\ApiStatusCountsApi();

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

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

eval { 
    my $result = $api_instance->gETStatusCounts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusCountsApi->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.StatusCountsApi()

try: 
    # Retrieves all status counts for all item types.
    api_response = api_instance.g_et_status_counts()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusCountsApi->gETStatusCounts: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCountsCanonical

Retrieves all status counts for canonical items.

Adds status counts for all pools 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.StatusCountsApi;

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

public class StatusCountsApiExample {

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

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

public class StatusCountsApiExample {

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

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

// Retrieves all status counts for canonical items.
[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.StatusCountsApi()
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 StatusCountsApi();

            try
            {
                // Retrieves all status counts for canonical items.
                canonical-item-status-counts result = apiInstance.gETStatusCountsCanonical();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusCountsApi.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\ApiStatusCountsApi();

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

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

eval { 
    my $result = $api_instance->gETStatusCountsCanonical();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusCountsApi->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.StatusCountsApi()

try: 
    # Retrieves all status counts for canonical items.
    api_response = api_instance.g_et_status_counts_canonical()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusCountsApi->gETStatusCountsCanonical: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCountsCanonicalPublication

Retrieves all status counts for canonical publication items.

Retrieves 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.StatusCountsApi;

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

public class StatusCountsApiExample {

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

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

public class StatusCountsApiExample {

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

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

// Retrieves all status counts for canonical publication items.
[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.StatusCountsApi()
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 StatusCountsApi();

            try
            {
                // Retrieves all status counts for canonical publication items.
                canonical-publication-item-status-counts result = apiInstance.gETStatusCountsCanonicalPublication();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusCountsApi.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\ApiStatusCountsApi();

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

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

eval { 
    my $result = $api_instance->gETStatusCountsCanonicalPublication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusCountsApi->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.StatusCountsApi()

try: 
    # Retrieves all status counts for canonical publication items.
    api_response = api_instance.g_et_status_counts_canonical_publication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusCountsApi->gETStatusCountsCanonicalPublication: %s\n" % e)

Parameters

Responses

Status: 200 -


gETStatusCountsRaw

Retrieves all status counts for raw items.

Adds status counts for all pools 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.StatusCountsApi;

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

public class StatusCountsApiExample {

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

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

public class StatusCountsApiExample {

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

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

// Retrieves all status counts for raw items.
[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.StatusCountsApi()
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 StatusCountsApi();

            try
            {
                // Retrieves all status counts for raw items.
                raw-item-status-counts result = apiInstance.gETStatusCountsRaw();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusCountsApi.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\ApiStatusCountsApi();

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

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

eval { 
    my $result = $api_instance->gETStatusCountsRaw();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusCountsApi->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.StatusCountsApi()

try: 
    # Retrieves all status counts for raw items.
    api_response = api_instance.g_et_status_counts_raw()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusCountsApi->gETStatusCountsRaw: %s\n" % e)

Parameters

Responses

Status: 200 -


TargetSystems

gETTargetSystems

Retrieves target systems.

Retrieves 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.TargetSystemsApi;

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

public class TargetSystemsApiExample {

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

        TargetSystemsApi apiInstance = new TargetSystemsApi();
        Integer pageNumber = 56; // Integer | Page number of the returned target systems.
        Integer pageSize = 56; // Integer | Number of results returned per page
        try {
            target-systems result = apiInstance.gETTargetSystems(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsApi#gETTargetSystems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TargetSystemsApi;

public class TargetSystemsApiExample {

    public static void main(String[] args) {
        TargetSystemsApi apiInstance = new TargetSystemsApi();
        Integer pageNumber = 56; // Integer | Page number of the returned target systems.
        Integer pageSize = 56; // Integer | Number of results returned per page
        try {
            target-systems result = apiInstance.gETTargetSystems(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsApi#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; // Page number of the returned target systems. (default to 0)
Integer *pageSize = 56; // Number of results returned per page (default to 50)

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

// Retrieves target systems.
[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.TargetSystemsApi()
var pageNumber = 56; // {{Integer}} Page number of the returned target systems.
var pageSize = 56; // {{Integer}} Number of results returned per page

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 TargetSystemsApi();
            var pageNumber = 56;  // Integer | Page number of the returned target systems. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page (default to 50)

            try
            {
                // Retrieves target systems.
                target-systems result = apiInstance.gETTargetSystems(pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TargetSystemsApi.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\ApiTargetSystemsApi();
$pageNumber = 56; // Integer | Page number of the returned target systems.
$pageSize = 56; // Integer | Number of results returned per page

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

my $api_instance = WWW::SwaggerClient::TargetSystemsApi->new();
my $pageNumber = 56; # Integer | Page number of the returned target systems.
my $pageSize = 56; # Integer | Number of results returned per page

eval { 
    my $result = $api_instance->gETTargetSystems(pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TargetSystemsApi->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.TargetSystemsApi()
pageNumber = 56 # Integer | Page number of the returned target systems. (default to 0)
pageSize = 56 # Integer | Number of results returned per page (default to 50)

try: 
    # Retrieves target systems.
    api_response = api_instance.g_et_target_systems(pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TargetSystemsApi->gETTargetSystems: %s\n" % e)

Parameters

Query parameters
Name Description
pageNumber*
Integer
Page number of the returned target systems.
Required
pageSize*
Integer
Number of results returned per page
Required

Responses

Status: 200 -


TargetSystemsPublications

gETTargetSystemPublications

Retrieves target system publications.

Retrieves 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.TargetSystemsPublicationsApi;

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

public class TargetSystemsPublicationsApiExample {

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

        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        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 | Page number of the returned target system publications.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            target-system-publications result = apiInstance.gETTargetSystemPublications(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsPublicationsApi#gETTargetSystemPublications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TargetSystemsPublicationsApi;

public class TargetSystemsPublicationsApiExample {

    public static void main(String[] args) {
        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        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 | Page number of the returned target system publications.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            target-system-publications result = apiInstance.gETTargetSystemPublications(q, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsPublicationsApi#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; // Page number of the returned target system publications. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves target system publications.
[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.TargetSystemsPublicationsApi()
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}} Page number of the returned target system publications.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 TargetSystemsPublicationsApi();
            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 | Page number of the returned target system publications. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves target system publications.
                target-system-publications result = apiInstance.gETTargetSystemPublications(q, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TargetSystemsPublicationsApi.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\ApiTargetSystemsPublicationsApi();
$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 | Page number of the returned target system publications.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::TargetSystemsPublicationsApi->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 | Page number of the returned target system publications.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETTargetSystemPublications(q => $q, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TargetSystemsPublicationsApi->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.TargetSystemsPublicationsApi()
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 | Page number of the returned target system publications. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves target system publications.
    api_response = api_instance.g_et_target_system_publications(q, pageNumber, pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TargetSystemsPublicationsApi->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
Page number of the returned target system publications.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationId

Retrieves a specific target system publication.

Retrieves the specified target system publication.


/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.TargetSystemsPublicationsApi;

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

public class TargetSystemsPublicationsApiExample {

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

        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String publicationId = publicationId_example; // String | Publication identifier 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 TargetSystemsPublicationsApi#gETTargetSystemPublicationsPublicationId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TargetSystemsPublicationsApi;

public class TargetSystemsPublicationsApiExample {

    public static void main(String[] args) {
        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String publicationId = publicationId_example; // String | Publication identifier 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 TargetSystemsPublicationsApi#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; // Publication identifier of the target system publication.

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

// Retrieves a specific target system publication.
[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.TargetSystemsPublicationsApi()
var publicationId = publicationId_example; // {{String}} Publication identifier 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 TargetSystemsPublicationsApi();
            var publicationId = publicationId_example;  // String | Publication identifier of the target system publication.

            try
            {
                // Retrieves a specific target system publication.
                target-system-publication result = apiInstance.gETTargetSystemPublicationsPublicationId(publicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TargetSystemsPublicationsApi.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\ApiTargetSystemsPublicationsApi();
$publicationId = publicationId_example; // String | Publication identifier of the target system publication.

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

my $api_instance = WWW::SwaggerClient::TargetSystemsPublicationsApi->new();
my $publicationId = publicationId_example; # String | Publication identifier of the target system publication.

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationId(publicationId => $publicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TargetSystemsPublicationsApi->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.TargetSystemsPublicationsApi()
publicationId = publicationId_example # String | Publication identifier of the target system publication.

try: 
    # Retrieves a specific target system publication.
    api_response = api_instance.g_et_target_system_publications_publication_id(publicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TargetSystemsPublicationsApi->gETTargetSystemPublicationsPublicationId: %s\n" % e)

Parameters

Path parameters
Name Description
publicationId*
String
Publication identifier of the target system publication.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationIdErrors

Retrieves target system publication errors.

Retrieves the errors of the specified target system publication.


/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.TargetSystemsPublicationsApi;

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

public class TargetSystemsPublicationsApiExample {

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

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

public class TargetSystemsPublicationsApiExample {

    public static void main(String[] args) {
        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String publicationId = publicationId_example; // String | Publication identifier of the target system publication.
        Integer pageNumber = 56; // Integer | Page number of the returned target system publication errors.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            errors result = apiInstance.gETTargetSystemPublicationsPublicationIdErrors(publicationId, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsPublicationsApi#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; // Publication identifier of the target system publication.
Integer *pageNumber = 56; // Page number of the returned target system publication errors. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves target system publication errors.
[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.TargetSystemsPublicationsApi()
var publicationId = publicationId_example; // {{String}} Publication identifier of the target system publication.
var pageNumber = 56; // {{Integer}} Page number of the returned target system publication errors.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 TargetSystemsPublicationsApi();
            var publicationId = publicationId_example;  // String | Publication identifier of the target system publication.
            var pageNumber = 56;  // Integer | Page number of the returned target system publication errors. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves target system publication errors.
                errors result = apiInstance.gETTargetSystemPublicationsPublicationIdErrors(publicationId, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TargetSystemsPublicationsApi.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\ApiTargetSystemsPublicationsApi();
$publicationId = publicationId_example; // String | Publication identifier of the target system publication.
$pageNumber = 56; // Integer | Page number of the returned target system publication errors.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::TargetSystemsPublicationsApi->new();
my $publicationId = publicationId_example; # String | Publication identifier of the target system publication.
my $pageNumber = 56; # Integer | Page number of the returned target system publication errors.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationIdErrors(publicationId => $publicationId, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TargetSystemsPublicationsApi->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.TargetSystemsPublicationsApi()
publicationId = publicationId_example # String | Publication identifier of the target system publication.
pageNumber = 56 # Integer | Page number of the returned target system publication errors. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves target system publication errors.
    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 TargetSystemsPublicationsApi->gETTargetSystemPublicationsPublicationIdErrors: %s\n" % e)

Parameters

Path parameters
Name Description
publicationId*
String
Publication identifier of the target system publication.
Required
Query parameters
Name Description
pageNumber*
Integer
Page number of the returned target system publication errors.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationIdItemStatuses

Retrieves statuses of a canonical publication item.

Retrieves the statuses of the specified canonical publication item.


/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.TargetSystemsPublicationsApi;

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

public class TargetSystemsPublicationsApiExample {

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

        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String publicationId = publicationId_example; // String | Publication identifier 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 | List of statuses to search for.
        Integer pageNumber = 56; // Integer | Page number of the returned item statuses.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            canonicalItemPublicationStatusItemList result = apiInstance.gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId, q, status, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsPublicationsApi#gETTargetSystemPublicationsPublicationIdItemStatuses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TargetSystemsPublicationsApi;

public class TargetSystemsPublicationsApiExample {

    public static void main(String[] args) {
        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String publicationId = publicationId_example; // String | Publication identifier 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 | List of statuses to search for.
        Integer pageNumber = 56; // Integer | Page number of the returned item statuses.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            canonicalItemPublicationStatusItemList result = apiInstance.gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId, q, status, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TargetSystemsPublicationsApi#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; // Publication identifier of the target system publication.
String *q = q_example; // Query string in lucene syntax.  Supported terms are 'status' (0-many)
String *status = status_example; // List of statuses to search for.
Integer *pageNumber = 56; // Page number of the returned item statuses. (default to 0)
Integer *pageSize = 56; // Number of results returned per page. (default to 50)

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

// Retrieves statuses of a canonical publication item.
[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.TargetSystemsPublicationsApi()
var publicationId = publicationId_example; // {{String}} Publication identifier 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}} List of statuses to search for.
var pageNumber = 56; // {{Integer}} Page number of the returned item statuses.
var pageSize = 56; // {{Integer}} Number of results returned per page.

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 TargetSystemsPublicationsApi();
            var publicationId = publicationId_example;  // String | Publication identifier 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 | List of statuses to search for.
            var pageNumber = 56;  // Integer | Page number of the returned item statuses. (default to 0)
            var pageSize = 56;  // Integer | Number of results returned per page. (default to 50)

            try
            {
                // Retrieves statuses of a canonical publication item.
                canonicalItemPublicationStatusItemList result = apiInstance.gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId, q, status, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TargetSystemsPublicationsApi.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\ApiTargetSystemsPublicationsApi();
$publicationId = publicationId_example; // String | Publication identifier of the target system publication.
$q = q_example; // String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
$status = status_example; // String | List of statuses to search for.
$pageNumber = 56; // Integer | Page number of the returned item statuses.
$pageSize = 56; // Integer | Number of results returned per page.

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

my $api_instance = WWW::SwaggerClient::TargetSystemsPublicationsApi->new();
my $publicationId = publicationId_example; # String | Publication identifier 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 | List of statuses to search for.
my $pageNumber = 56; # Integer | Page number of the returned item statuses.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationIdItemStatuses(publicationId => $publicationId, q => $q, status => $status, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TargetSystemsPublicationsApi->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.TargetSystemsPublicationsApi()
publicationId = publicationId_example # String | Publication identifier of the target system publication.
q = q_example # String | Query string in lucene syntax.  Supported terms are 'status' (0-many)
status = status_example # String | List of statuses to search for.
pageNumber = 56 # Integer | Page number of the returned item statuses. (default to 0)
pageSize = 56 # Integer | Number of results returned per page. (default to 50)

try: 
    # Retrieves statuses of a canonical publication item.
    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 TargetSystemsPublicationsApi->gETTargetSystemPublicationsPublicationIdItemStatuses: %s\n" % e)

Parameters

Path parameters
Name Description
publicationId*
String
Publication identifier 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
List of statuses to search for.
Required
pageNumber*
Integer
Page number of the returned item statuses.
Required
pageSize*
Integer
Number of results returned per page.
Required

Responses

Status: 200 -


gETTargetSystemPublicationsPublicationIdItemsItemType

Retrieves all items.

Retrieves all items for the specified publication and item 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.TargetSystemsPublicationsApi;

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

public class TargetSystemsPublicationsApiExample {

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

        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        String publicationId = publicationId_example; // String | Publication identifier 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 TargetSystemsPublicationsApi#gETTargetSystemPublicationsPublicationIdItemsItemType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TargetSystemsPublicationsApi;

public class TargetSystemsPublicationsApiExample {

    public static void main(String[] args) {
        TargetSystemsPublicationsApi apiInstance = new TargetSystemsPublicationsApi();
        String itemType = itemType_example; // String | Type of item to be retrieved.
        String publicationId = publicationId_example; // String | Publication identifier 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 TargetSystemsPublicationsApi#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; // Type of item to be retrieved.
String *publicationId = publicationId_example; // Publication identifier of the target system publication.

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

// Retrieves all items.
[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.TargetSystemsPublicationsApi()
var itemType = itemType_example; // {{String}} Type of item to be retrieved.
var publicationId = publicationId_example; // {{String}} Publication identifier 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 TargetSystemsPublicationsApi();
            var itemType = itemType_example;  // String | Type of item to be retrieved.
            var publicationId = publicationId_example;  // String | Publication identifier of the target system publication.

            try
            {
                // Retrieves all items.
                data-items result = apiInstance.gETTargetSystemPublicationsPublicationIdItemsItemType(itemType, publicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TargetSystemsPublicationsApi.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\ApiTargetSystemsPublicationsApi();
$itemType = itemType_example; // String | Type of item to be retrieved.
$publicationId = publicationId_example; // String | Publication identifier of the target system publication.

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

my $api_instance = WWW::SwaggerClient::TargetSystemsPublicationsApi->new();
my $itemType = itemType_example; # String | Type of item to be retrieved.
my $publicationId = publicationId_example; # String | Publication identifier of the target system publication.

eval { 
    my $result = $api_instance->gETTargetSystemPublicationsPublicationIdItemsItemType(itemType => $itemType, publicationId => $publicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TargetSystemsPublicationsApi->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.TargetSystemsPublicationsApi()
itemType = itemType_example # String | Type of item to be retrieved.
publicationId = publicationId_example # String | Publication identifier of the target system publication.

try: 
    # Retrieves all items.
    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 TargetSystemsPublicationsApi->gETTargetSystemPublicationsPublicationIdItemsItemType: %s\n" % e)

Parameters

Path parameters
Name Description
itemType*
String
Type of item to be retrieved.
Required
publicationId*
String
Publication identifier of the target system publication.
Required

Responses

Status: 200 -


Version

gETVersion

Retrieves the current Data Hub version.

Retrieves the version of Data Hub that's 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.VersionApi;

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

public class VersionApiExample {

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

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

public class VersionApiExample {

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

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

// Retrieves the current Data Hub version.
[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.VersionApi()
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 VersionApi();

            try
            {
                // Retrieves the current Data Hub version.
                apiInstance.gETVersion();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionApi.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\ApiVersionApi();

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

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

eval { 
    $api_instance->gETVersion();
};
if ($@) {
    warn "Exception when calling VersionApi->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.VersionApi()

try: 
    # Retrieves the current Data Hub version.
    api_instance.g_et_version()
except ApiException as e:
    print("Exception when calling VersionApi->gETVersion: %s\n" % e)

Parameters

Responses

Status: 200 -