TIBCO HCA Cloud Streaming Common Data Channel Server Infrastructure

Authentication

login

Log in to this service. Establishes a data channel session. On successful login, the server returns an API token in the X-TIBCO-HCA-Data-Channel-Server-API-Token HTTP response header. That token must then be used as a Bearer token for any endpoints annotated as using HTTP bearer authentication. Authorization: Bearer <token> The API token expires after a configurable amount of time. When an API token expires, login must be repeated to get a new API token.

/v1/login

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"/channel/v1/login"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {

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

        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            apiInstance.login();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Log in to this service.
[apiInstance loginWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure = require('tibco_hca_cloud_streaming_common_data_channel_server_infrastructure');
var defaultClient = TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.login(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AuthenticationApi();

            try
            {
                // Log in to this service.
                apiInstance.login();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.login: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $api_instance->login();
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->login: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    $api_instance->login();
};
if ($@) {
    warn "Exception when calling AuthenticationApi->login: $@\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: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Log in to this service.
    api_instance.login()
except ApiException as e:
    print("Exception when calling AuthenticationApi->login: %s\n" % e)

Parameters

Responses

Status: 200 - Login was successful.

Headers

Name	Type	Format	Description
X-TIBCO-HCA-Data-Channel-Server-API-Token	String

Status: 401 - Authentication information is missing or invalid

Status: 500 - Internal server error, contact support.

Schema

logout

Log out from this service.

Log from this service, terminating the data channel session. The API token is invalid after this operation completes. The login operation must be executed again to get a new valid API token.

/v1/logout

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/channel/v1/logout"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {

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


        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#logout");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Log out from this service.
[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure = require('tibco_hca_cloud_streaming_common_data_channel_server_infrastructure');
var defaultClient = TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.ApiClient.instance;


var api = new TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.logout(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AuthenticationApi();

            try
            {
                // Log out from this service.
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.logout: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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

try {
    $api_instance->logout();
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;


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

eval { 
    $api_instance->logout();
};
if ($@) {
    warn "Exception when calling AuthenticationApi->logout: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


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

try: 
    # Log out from this service.
    api_instance.logout()
except ApiException as e:
    print("Exception when calling AuthenticationApi->logout: %s\n" % e)

Parameters

Responses

Status: 200 - Logout was successful.

Status: 401 - Session token is missing or invalid

Status: 500 - Internal server error, contact support.

Schema

Channel

getDescription

Return the server's data channel metadata document.

Return the server's data channel metadata document. The metadata document describes the channel, including its direction and data schema.

/v1/description

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/channel/v1/description"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChannelApi;

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

public class ChannelApiExample {

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


        ChannelApi apiInstance = new ChannelApi();
        try {
            DataChannelMetadata result = apiInstance.getDescription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#getDescription");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ChannelApi;

public class ChannelApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Return the server's data channel metadata document.
[apiInstance getDescriptionWithCompletionHandler: 
              ^(DataChannelMetadata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure = require('tibco_hca_cloud_streaming_common_data_channel_server_infrastructure');
var defaultClient = TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.ApiClient.instance;


var api = new TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.ChannelApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescription(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ChannelApi();

            try
            {
                // Return the server's data channel metadata document.
                DataChannelMetadata result = apiInstance.getDescription();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelApi.getDescription: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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

try {
    $result = $api_instance->getDescription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelApi->getDescription: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChannelApi;


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

eval { 
    my $result = $api_instance->getDescription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChannelApi->getDescription: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


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

try: 
    # Return the server's data channel metadata document.
    api_response = api_instance.get_description()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChannelApi->getDescription: %s\n" % e)

Parameters

Responses

Status: 200 - Data channel metadata in string form.

Schema

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Schema

Status: 500 - Internal server error, contact support.

Schema

Notification

streaming

Create a data channel stream

This is a WebSocket data channel stream accessed using the ws: protocol. After HTTP upgrade, the client will have a WebSocket that either sends (sink data channel) or receives (source data channel) instances of the channel's data schema using HCA Cloud Streaming serialization format.

/v1/streaming

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/channel/v1/streaming"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationApi;

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

public class NotificationApiExample {

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


        NotificationApi apiInstance = new NotificationApi();
        try {
            DataMessage result = apiInstance.streaming();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#streaming");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NotificationApi;

public class NotificationApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Create a data channel stream
[apiInstance streamingWithCompletionHandler: 
              ^(DataMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure = require('tibco_hca_cloud_streaming_common_data_channel_server_infrastructure');
var defaultClient = TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.ApiClient.instance;


var api = new TibcoHcaCloudStreamingCommonDataChannelServerInfrastructure.NotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.streaming(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new NotificationApi();

            try
            {
                // Create a data channel stream
                DataMessage result = apiInstance.streaming();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationApi.streaming: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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

try {
    $result = $api_instance->streaming();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->streaming: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotificationApi;


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

eval { 
    my $result = $api_instance->streaming();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationApi->streaming: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


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

try: 
    # Create a data channel stream
    api_response = api_instance.streaming()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationApi->streaming: %s\n" % e)

TIBCO HCA Cloud Streaming Common Data Channel Server Infrastructure

API and SDK Documentation

Authentication

logout

Usage and SDK Samples

Parameters

Responses

Status: 200 - Logout was successful.

Status: 401 - Session token is missing or invalid

Status: 500 - Internal server error, contact support.

Channel

getDescription

Usage and SDK Samples

Parameters

Responses

Status: 200 - Data channel metadata in string form.

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support.

Notification

streaming

Usage and SDK Samples

Parameters

Responses

Status: 200 - WebSocket data channel record stream

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support.