TIBCO REST Data Source

Request

data

Send one or more requests to a pipeline for execution.

Multiple requests can be included in a single call to this API. Each request is transformed into a record and then sent to all connected pipelines one at a time.

Sending a request if there are no connected pipelines returns a 500 response status.

/data

Usage and SDK Samples

curl -X POST\
-H "X-TIBCO-HCA-Data-Channel-Server-API-Token: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//data"

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

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

public class RequestApiExample {

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

        // Configure API key authorization: ApiTokenKey
        ApiKeyAuth ApiTokenKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiTokenKey");
        ApiTokenKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiTokenKey.setApiKeyPrefix("Token");

        RequestApi apiInstance = new RequestApi();
        array[InputData] body = ; // array[InputData] | 
        try {
            apiInstance.data(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestApi#data");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.RequestApi;

public class RequestApiExample {

    public static void main(String[] args) {
        RequestApi apiInstance = new RequestApi();
        array[InputData] body = ; // array[InputData] | 
        try {
            apiInstance.data(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestApi#data");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TIBCO-HCA-Data-Channel-Server-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TIBCO-HCA-Data-Channel-Server-API-Token"];
array[InputData] *body = ; //  (optional)

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

[apiInstance dataWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var TibcoRestDataSource = require('tibco_rest_data_source');
var defaultClient = TibcoRestDataSource.ApiClient.instance;

// Configure API key authorization: ApiTokenKey
var ApiTokenKey = defaultClient.authentications['ApiTokenKey'];
ApiTokenKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiTokenKey.apiKeyPrefix['X-TIBCO-HCA-Data-Channel-Server-API-Token'] = "Token"

var api = new TibcoRestDataSource.RequestApi()
var opts = { 
  'body':  // {{array[InputData]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.data(opts, callback);

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

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

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-TIBCO-HCA-Data-Channel-Server-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TIBCO-HCA-Data-Channel-Server-API-Token", "Bearer");

            var apiInstance = new RequestApi();
            var body = new array[InputData](); // array[InputData] |  (optional) 

            try
            {
                apiInstance.data(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestApi.data: " + e.Message );
            }
        }
    }
}

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

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TIBCO-HCA-Data-Channel-Server-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TIBCO-HCA-Data-Channel-Server-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiRequestApi();
$body = ; // array[InputData] | 

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-TIBCO-HCA-Data-Channel-Server-API-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-TIBCO-HCA-Data-Channel-Server-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RequestApi->new();
my $body = [WWW::SwaggerClient::Object::array[InputData]->new()]; # array[InputData] | 

eval { 
    $api_instance->data(body => $body);
};
if ($@) {
    warn "Exception when calling RequestApi->data: $@\n";
}

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

# Configure API key authorization: ApiTokenKey
swagger_client.configuration.api_key['X-TIBCO-HCA-Data-Channel-Server-API-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-TIBCO-HCA-Data-Channel-Server-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RequestApi()
body =  # array[InputData] |  (optional)

try: 
    api_instance.data(body=body)
except ApiException as e:
    print("Exception when calling RequestApi->data: %s\n" % e)

Parameters

Body parameters

Name	Description
body	[ Request data { Request data. Each array element generates a single record to all connected pipelines. The schema of the array element is defined by the configured data channel schema. } ]

Responses

Status: 200 - Success

Status: 401 - Token is expired, revoked, malformed, or invalid.

Headers

Name	Type	Format	Description
WWW-Authenticate	String

Status: 400 - The entity of the request is in a format not supported by the requested resource for the requested method.

Schema

{

An error response.

Required: message,statusCode

statusCode:

integer (int32)

Numeric error code.

message:

string

Error message.

}

Status: 500 - Internal server error, or no pipelines are connected to the data channel.

Schema

{

An error response.

Required: message,statusCode

statusCode:

integer (int32)

Numeric error code.

message:

string

Error message.

}

Session

login

/login

Usage and SDK Samples

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

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

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

public class SessionApiExample {

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


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

import io.swagger.client.api.SessionApi;

public class SessionApiExample {

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

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

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

[apiInstance loginWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

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


var api = new TibcoRestDataSource.SessionApi()
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 SessionApi();

            try
            {
                apiInstance.login();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionApi.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\ApiSessionApi();

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

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

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

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

try: 
    api_instance.login()
except ApiException as e:
    print("Exception when calling SessionApi->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.

Headers

Name	Type	Format	Description
WWW-Authenticate	String

Status: 500 - Internal server error, contact support.

Schema

{

An error response.

Required: message,statusCode

statusCode:

integer (int32)

Numeric error code.

message:

string

Error message.

}

logout

Terminate a REST data source login session.

/logout

Usage and SDK Samples

curl -X POST\
-H "X-TIBCO-HCA-Data-Channel-Server-API-Token: [[apiKey]]"\
-H "Accept: application/json"\
"//logout"

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

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

public class SessionApiExample {

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

        // Configure API key authorization: ApiTokenKey
        ApiKeyAuth ApiTokenKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiTokenKey");
        ApiTokenKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiTokenKey.setApiKeyPrefix("Token");

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

import io.swagger.client.api.SessionApi;

public class SessionApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TIBCO-HCA-Data-Channel-Server-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TIBCO-HCA-Data-Channel-Server-API-Token"];

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

[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var TibcoRestDataSource = require('tibco_rest_data_source');
var defaultClient = TibcoRestDataSource.ApiClient.instance;

// Configure API key authorization: ApiTokenKey
var ApiTokenKey = defaultClient.authentications['ApiTokenKey'];
ApiTokenKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiTokenKey.apiKeyPrefix['X-TIBCO-HCA-Data-Channel-Server-API-Token'] = "Token"

var api = new TibcoRestDataSource.SessionApi()
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()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-TIBCO-HCA-Data-Channel-Server-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TIBCO-HCA-Data-Channel-Server-API-Token", "Bearer");

            var apiInstance = new SessionApi();

            try
            {
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionApi.logout: " + e.Message );
            }
        }
    }
}

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

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TIBCO-HCA-Data-Channel-Server-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TIBCO-HCA-Data-Channel-Server-API-Token', 'Bearer');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-TIBCO-HCA-Data-Channel-Server-API-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-TIBCO-HCA-Data-Channel-Server-API-Token'} = "Bearer";

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

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

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

# Configure API key authorization: ApiTokenKey
swagger_client.configuration.api_key['X-TIBCO-HCA-Data-Channel-Server-API-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-TIBCO-HCA-Data-Channel-Server-API-Token'] = 'Bearer'

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

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

Parameters

Responses

Status: 200 - Logout was successful.

Status: 401 - Token is expired, revoked, malformed, or invalid.

Headers

Name	Type	Format	Description
WWW-Authenticate	String

Status: 500 - Internal server error, contact support.

Schema

{

An error response.

Required: message,statusCode

statusCode:

integer (int32)

Numeric error code.

message:

string

Error message.

}

TIBCO REST Data Source

API and SDK Documentation

Request

data

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 401 - Token is expired, revoked, malformed, or invalid.

Status: 400 - The entity of the request is in a format not supported by the requested resource for the requested method.

Status: 500 - Internal server error, or no pipelines are connected to the data channel.

Session

login

Usage and SDK Samples

Parameters

Responses

Status: 200 - Login was successful.

Status: 401 - Authentication information is missing or invalid.

Status: 500 - Internal server error, contact support.

logout

Usage and SDK Samples

Parameters

Responses

Status: 200 - Logout was successful.

Status: 401 - Token is expired, revoked, malformed, or invalid.

Status: 500 - Internal server error, contact support.